573 lines
15 KiB
Perl
573 lines
15 KiB
Perl
package WebGUI::FilePump::Bundle;
|
|
|
|
use base qw/WebGUI::Crud/;
|
|
use WebGUI::International;
|
|
use WebGUI::Utility;
|
|
use URI;
|
|
use Path::Class::Dir;
|
|
use CSS::Minifier::XS;
|
|
use JavaScript::Minifier::XS;
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 addFile ( $type, $uri )
|
|
|
|
Adds a file of the requested type to the bundle. Returns 1 if the add was successful.
|
|
Otherwise, returns 0 and an error message as to why it was not successful.
|
|
|
|
=head3 $type
|
|
|
|
If $type is JS, it adds it to the javascript part of the bundle. If it is
|
|
CSS, it adds it to the CSS part of the bundle. OTHER is used for all other
|
|
types of files.
|
|
|
|
=head3 $uri
|
|
|
|
A URI to the new file to add. If the URI already exists in that part of the bundle,
|
|
it will return 0 and an error message.
|
|
|
|
=cut
|
|
|
|
sub addFile {
|
|
my ($self, $type, $uri) = @_;
|
|
return 0, 'Illegal type' unless WebGUI::Utility::isIn($type, 'JS', 'CSS', 'OTHER');
|
|
return 0, 'No URI' unless $uri;
|
|
my $collateralType = $type eq 'JS' ? 'jsFiles'
|
|
: $type eq 'CSS' ? 'cssFiles'
|
|
: 'otherFiles';
|
|
my $files = $self->get($collateralType);
|
|
my $uriExists = $self->getCollateralDataIndex($files, 'uri', $uri) != -1 ? 1 : 0;
|
|
return 0, 'Duplicate URI' if $uriExists;
|
|
$self->setCollateral(
|
|
$collateralType,
|
|
'fileId',
|
|
'new',
|
|
{
|
|
uri => $uri,
|
|
lastModified => 0,
|
|
},
|
|
);
|
|
$self->update({lastModified => time()});
|
|
return 1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 build ( )
|
|
|
|
build goes through and fetches all files referenced in all URIs stored for
|
|
this bundle. It downloads them, stores their modification time for future
|
|
checks, and then does special processing, depending on the type of file.
|
|
|
|
Javascript files are concatenated together in order, and minimized. The
|
|
resulting data is stored in the filepump area under the uploads directory
|
|
with the name bundleName.timestamp/bundleName.js
|
|
|
|
CSS files are handled likewise, except that the name is bundleName.timestamp/bundleName.css.
|
|
|
|
Other files are copied from their current location into the timestamped bundle directory.
|
|
|
|
Older timestamped build directories are removed.
|
|
|
|
If the build is successful, it will return 1. Otherwise, if problems
|
|
occur during the build, then the old build directory is not affected and
|
|
the method returns 0, along with an error message.
|
|
|
|
=cut
|
|
|
|
sub build {
|
|
my ($self) = @_;
|
|
my $lastBuild = time();
|
|
my $originalBuild = $self->get('lastBuild');
|
|
$self->update({lastBuild => $lastBuild});
|
|
return 1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 crud_definition
|
|
|
|
WebGUI::Crud definition for this class.
|
|
|
|
=head3 tableName
|
|
|
|
filePumpBundle
|
|
|
|
=head3 tableKey
|
|
|
|
bundleId
|
|
|
|
=head3 sequenceKey
|
|
|
|
None. Bundles have no sequence amongst themselves.
|
|
|
|
=head3 properties
|
|
|
|
=head4 bundleName
|
|
|
|
The name of a bundle
|
|
|
|
=head4 lastBuild
|
|
|
|
The date the bundle was last built. This is used to generate the name of the bundled files
|
|
for this bundle.
|
|
|
|
=head4 lastModified
|
|
|
|
The date the bundle was last modified. With this, and the lastBuild date, you can determine
|
|
which bundles need to be rebuilt.
|
|
|
|
=head4 jsFiles, cssFiles, otherFiles
|
|
|
|
JSON blobs with files attached to the bundle. js = javascript, css = Cascading Style Sheets, other
|
|
means anything else.
|
|
|
|
=cut
|
|
|
|
sub crud_definition {
|
|
my ($class, $session) = @_;
|
|
my $definition = $class->SUPER::crud_definition($session);
|
|
my $i18n = WebGUI::International->new($session, 'FilePump');
|
|
$definition->{tableName} = 'filePumpBundle';
|
|
$definition->{tableKey} = 'bundleId';
|
|
$definition->{sequenceKey} = '';
|
|
my $properties = $definition->{properties};
|
|
$properties->{bundleName} = {
|
|
fieldName => 'text',
|
|
defaultValue => $i18n->get('new bundle'),
|
|
};
|
|
$properties->{lastModified} = {
|
|
fieldName => 'integer',
|
|
defaultValue => 0,
|
|
};
|
|
$properties->{lastBuild} = {
|
|
fieldName => 'integer',
|
|
defaultValue => 0,
|
|
};
|
|
$properties->{jsFiles} = {
|
|
fieldName => 'textarea',
|
|
defaultValue => [],
|
|
serialize => 1,
|
|
};
|
|
$properties->{cssFiles} = {
|
|
fieldName => 'textarea',
|
|
defaultValue => [],
|
|
serialize => 1,
|
|
};
|
|
$properties->{otherFiles} = {
|
|
fieldName => 'textarea',
|
|
defaultValue => [],
|
|
serialize => 1,
|
|
};
|
|
return $definition;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 delete ( )
|
|
|
|
Extend the method from WebGUI::Crud to handle deleting the locally stored
|
|
files.
|
|
|
|
=cut
|
|
|
|
sub delete {
|
|
my ($self) = @_;
|
|
my $bundleDir = $self->getPathClassDir();
|
|
$bundleDir->rmtree();
|
|
return $self->SUPER::delete;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 deleteCollateral ( tableName, keyName, keyValue )
|
|
|
|
Deletes a row of collateral data.
|
|
|
|
=head3 tableName
|
|
|
|
The name of the table you wish to delete the data from.
|
|
|
|
=head3 keyName
|
|
|
|
The name of a key in the collateral hash. Typically a unique identifier for a given
|
|
"row" of collateral data.
|
|
|
|
=head3 keyValue
|
|
|
|
Along with keyName, determines which "row" of collateral data to delete.
|
|
|
|
=cut
|
|
|
|
sub deleteCollateral {
|
|
my $self = shift;
|
|
my $tableName = shift;
|
|
my $keyName = shift;
|
|
my $keyValue = shift;
|
|
my $table = $self->get($tableName);
|
|
my $index = $self->getCollateralDataIndex($table, $keyName, $keyValue);
|
|
return if $index == -1;
|
|
splice @{ $table }, $index, 1;
|
|
$self->update({ $tableName => $table });
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 deleteFile ( $type, $fileId )
|
|
|
|
Deletes a file of the requested type from the bundle.
|
|
|
|
=head3 $type
|
|
|
|
If $type is JS, it deletes it from the javascript part of the bundle. If it is
|
|
CSS, it deletes it from the CSS part of the bundle. OTHER is used for all other
|
|
types of files.
|
|
|
|
=head3 $fileId
|
|
|
|
The unique collateral GUID to delete from the bundle.
|
|
|
|
=cut
|
|
|
|
sub deleteFile {
|
|
my ($self, $type, $fileId) = @_;
|
|
return 0, 'Illegal type' unless WebGUI::Utility::isIn($type, 'JS', 'CSS', 'OTHER');
|
|
return 0, 'No fileId' unless $fileId;
|
|
my $collateralType = $type eq 'JS' ? 'jsFiles'
|
|
: $type eq 'CSS' ? 'cssFiles'
|
|
: 'otherFiles';
|
|
$self->deleteCollateral(
|
|
$collateralType,
|
|
'fileId',
|
|
$fileId,
|
|
);
|
|
$self->update({lastModified => time()});
|
|
return 1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getCollateral ( tableName, keyName, keyValue )
|
|
|
|
Returns a hash reference containing one row of collateral data from a particular
|
|
table.
|
|
|
|
=head3 tableName
|
|
|
|
The name of the table you wish to retrieve the data from.
|
|
|
|
=head3 keyName
|
|
|
|
The name of a key in the collateral hash. Typically a unique identifier for a given
|
|
"row" of collateral data.
|
|
|
|
=head3 keyValue
|
|
|
|
Along with keyName, determines which "row" of collateral data to delete.
|
|
If this is equal to "new", then an empty hashRef will be returned to avoid
|
|
strict errors in the caller. If the requested data does not exist in the
|
|
collateral array, it also returns an empty hashRef.
|
|
|
|
=cut
|
|
|
|
sub getCollateral {
|
|
my $self = shift;
|
|
my $tableName = shift;
|
|
my $keyName = shift;
|
|
my $keyValue = shift;
|
|
if ($keyValue eq "new" || $keyValue eq "") {
|
|
return {};
|
|
}
|
|
my $table = $self->get($tableName);
|
|
my $index = $self->getCollateralDataIndex($table, $keyName, $keyValue);
|
|
return {} if $index == -1;
|
|
my %copy = %{ $table->[$index] };
|
|
return \%copy;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getCollateralDataIndex ( table, keyName, keyValue )
|
|
|
|
Returns the index in a set of collateral where an element of the
|
|
data (keyName) has a certain value (keyValue). If the criteria
|
|
are not found, returns -1.
|
|
|
|
=head3 table
|
|
|
|
The collateral data to search
|
|
|
|
=head3 keyName
|
|
|
|
The name of a key in the collateral hash.
|
|
|
|
=head3 keyValue
|
|
|
|
The value that keyName should have to meet the criteria.
|
|
|
|
=cut
|
|
|
|
sub getCollateralDataIndex {
|
|
my $self = shift;
|
|
my $table = shift;
|
|
my $keyName = shift;
|
|
my $keyValue = shift;
|
|
for (my $index=0; $index <= $#{ $table }; $index++) {
|
|
return $index
|
|
if (exists($table->[$index]->{$keyName}) && ($table->[$index]->{$keyName} eq $keyValue ));
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getPathClassDir ( )
|
|
|
|
Returns a Path::Class::Dir object to the last build directory
|
|
for this bundle.
|
|
|
|
=cut
|
|
|
|
sub getPathClassDir {
|
|
my ($self) = @_;
|
|
return Path::Class::Dir->new(
|
|
$self->session->config->get('uploadsPath'),
|
|
'filepump',
|
|
$self->get('bundleName') . $self->get('lastBuild')
|
|
);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 getOutOfDateBundles ( $session )
|
|
|
|
This is a class method. It returns an array reference of WebGUI::FilePump::Bundle
|
|
objects that need to be rebuilt.
|
|
|
|
=head3 $session
|
|
|
|
A WebGUI::Session object.
|
|
|
|
=cut
|
|
|
|
sub getOutOfDateBundles {
|
|
my ($class, $session) = @_;
|
|
my $oldBundles = [];
|
|
my $oldBundleIterator = $class->getAllIterator({
|
|
constraints => [
|
|
'lastBuild < lastModified' => [],
|
|
],
|
|
});
|
|
while (my $bundle = $oldBundleIterator->()) {
|
|
push @{ $oldBundles }, $bundle;
|
|
}
|
|
return $oldBundles;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 moveCollateralDown ( tableName, keyName, keyValue )
|
|
|
|
Moves a collateral data item down one position. If called on the last element of the
|
|
collateral array then it does nothing. Returns 1 if the move is successful. Returns
|
|
undef or the empty array otherwise.
|
|
|
|
=head3 tableName
|
|
|
|
A string indicating the table that contains the collateral data.
|
|
|
|
=head3 keyName
|
|
|
|
The name of a key in the collateral hash. Typically a unique identifier for a given
|
|
"row" of collateral data.
|
|
|
|
=head3 keyValue
|
|
|
|
Along with keyName, determines which "row" of collateral data to move.
|
|
|
|
=cut
|
|
|
|
sub moveCollateralDown {
|
|
my $self = shift;
|
|
my $tableName = shift;
|
|
my $keyName = shift;
|
|
my $keyValue = shift;
|
|
|
|
my $table = $self->get($tableName);
|
|
my $index = $self->getCollateralDataIndex($table, $keyName, $keyValue);
|
|
return if $index == -1;
|
|
return unless (abs($index) < $#{$table});
|
|
@{ $table }[$index,$index+1] = @{ $table }[$index+1,$index];
|
|
$self->update({ $tableName => $table });
|
|
return 1;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 moveCollateralUp ( tableName, keyName, keyValue )
|
|
|
|
Moves a collateral data item up one position. If called on the first element of the
|
|
collateral array then it does nothing. Returns 1 if the move is successful. Returns
|
|
undef or the empty array otherwise.
|
|
|
|
|
|
=head3 tableName
|
|
|
|
A string indicating the table that contains the collateral data.
|
|
|
|
=head3 keyName
|
|
|
|
The name of a key in the collateral hash. Typically a unique identifier for a given
|
|
"row" of collateral data.
|
|
|
|
=head3 keyValue
|
|
|
|
Along with keyName, determines which "row" of collateral data to move.
|
|
|
|
=cut
|
|
|
|
sub moveCollateralUp {
|
|
my $self = shift;
|
|
my $tableName = shift;
|
|
my $keyName = shift;
|
|
my $keyValue = shift;
|
|
|
|
my $table = $self->get($tableName);
|
|
my $index = $self->getCollateralDataIndex($table, $keyName, $keyValue);
|
|
return if $index == -1;
|
|
return unless $index && (abs($index) <= $#{$table});
|
|
@{ $table }[$index-1,$index] = @{ $table }[$index,$index-1];
|
|
$self->update({ $tableName => $table });
|
|
return 1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 moveFileDown ( $type, $fileId )
|
|
|
|
Moves the requested file down in the ordered collateral.
|
|
|
|
=head3 $type
|
|
|
|
If $type is JS, it moves a file in the javascript part of the bundle. If it is
|
|
CSS, it moves a file in the CSS part of the bundle. OTHER is used for all other
|
|
types of files.
|
|
|
|
=head3 $fileId
|
|
|
|
The unique collateral GUID to move in the bundle.
|
|
|
|
=cut
|
|
|
|
sub moveFileDown {
|
|
my ($self, $type, $fileId) = @_;
|
|
return 0, 'Illegal type' unless WebGUI::Utility::isIn($type, 'JS', 'CSS', 'OTHER');
|
|
return 0, 'No fileId' unless $fileId;
|
|
my $collateralType = $type eq 'JS' ? 'jsFiles'
|
|
: $type eq 'CSS' ? 'cssFiles'
|
|
: 'otherFiles';
|
|
$self->moveCollateralDown(
|
|
$collateralType,
|
|
'fileId',
|
|
$fileId,
|
|
);
|
|
$self->update({lastModified => time()});
|
|
return 1;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 moveFileUp ( $type, $fileId )
|
|
|
|
Moves the requested file up in the ordered collateral.
|
|
|
|
=head3 $type
|
|
|
|
If $type is JS, it moves a file in the javascript part of the bundle. If it is
|
|
CSS, it moves a file in the CSS part of the bundle. OTHER is used for all other
|
|
types of files.
|
|
|
|
=head3 $fileId
|
|
|
|
The unique collateral GUID to move in the bundle.
|
|
|
|
=cut
|
|
|
|
sub moveFileUp {
|
|
my ($self, $type, $fileId) = @_;
|
|
return 0, 'Illegal type' unless WebGUI::Utility::isIn($type, 'JS', 'CSS', 'OTHER');
|
|
return 0, 'No fileId' unless $fileId;
|
|
my $collateralType = $type eq 'JS' ? 'jsFiles'
|
|
: $type eq 'CSS' ? 'cssFiles'
|
|
: 'otherFiles';
|
|
$self->moveCollateralUp(
|
|
$collateralType,
|
|
'fileId',
|
|
$fileId,
|
|
);
|
|
$self->update({lastModified => time()});
|
|
return 1;
|
|
}
|
|
|
|
|
|
#-----------------------------------------------------------------
|
|
|
|
=head2 setCollateral ( tableName, keyName, keyValue, properties )
|
|
|
|
Performs and insert/update of collateral data for any wobject's collateral data.
|
|
Returns the id of the data that was set, even if a new row was added to the
|
|
data.
|
|
|
|
=head3 tableName
|
|
|
|
The name of the table to insert the data.
|
|
|
|
=head3 keyName
|
|
|
|
The name of a key in the collateral hash. Typically a unique identifier for a given
|
|
"row" of collateral data.
|
|
|
|
=head3 keyValue
|
|
|
|
Along with keyName, determines which "row" of collateral data to set.
|
|
The index of the collateral data to set. If the keyValue = "new", then a
|
|
new entry will be appended to the end of the collateral array. Otherwise,
|
|
the appropriate entry will be overwritten with the new data.
|
|
|
|
=head3 properties
|
|
|
|
A hash reference containing the name/value pairs to be inserted into the collateral, using
|
|
the criteria mentioned above.
|
|
|
|
=cut
|
|
|
|
sub setCollateral {
|
|
my $self = shift;
|
|
my $tableName = shift;
|
|
my $keyName = shift;
|
|
my $keyValue = shift;
|
|
my $properties = shift;
|
|
##Note, since this returns a reference, it is actually updating
|
|
##the object cache directly.
|
|
my $table = $self->get($tableName);
|
|
if ($keyValue eq 'new' || $keyValue eq '') {
|
|
if (! exists $properties->{$keyName}
|
|
or $properties->{$keyName} eq 'new'
|
|
or $properties->{$keyName} eq '') {
|
|
$properties->{$keyName} = $self->session->id->generate;
|
|
}
|
|
push @{ $table }, $properties;
|
|
$self->update({$tableName => $table});
|
|
return $properties->{$keyName};
|
|
}
|
|
my $index = $self->getCollateralDataIndex($table, $keyName, $keyValue);
|
|
return if $index == -1;
|
|
$table->[$index] = $properties;
|
|
$self->update({ $tableName => $table });
|
|
return $keyValue;
|
|
}
|
|
|
|
|
|
1;
|