first pass RT4 merge, RT#13852

[freeside.git] / rt / lib / RT / Squish.pm

diff --git a/rt/lib/RT/Squish.pm b/rt/lib/RT/Squish.pm
new file mode 100644 (file)
index 0000000..eb31a63
--- /dev/null
+++ b/rt/lib/RT/Squish.pm
@@ -0,0 +1,122 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+#
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+base class of RT::Squish::JS and RT::Squish::CSS
+
+=head1 METHODS
+
+=cut
+
+use strict;
+use warnings;
+
+package RT::Squish;
+use base 'Class::Accessor::Fast';
+__PACKAGE__->mk_accessors(qw/Content Key ModifiedTime ModifiedTimeString/);
+
+use Digest::MD5 'md5_hex';
+use HTTP::Date;
+
+=head2 new (ARGS)
+
+ARGS is a hash of named parameters.  Valid parameters are:
+
+  Name - name for this object
+
+=cut
+
+sub new {
+    my $class = shift;
+    my %args  = @_;
+    my $self  = \%args;
+    bless $self, $class;
+
+    my $content = $self->Squish;
+    $self->Content($content);
+    $self->Key( md5_hex $content );
+    $self->ModifiedTime( time() );
+    $self->ModifiedTimeString( HTTP::Date::time2str( $self->ModifiedTime ) );
+    return $self;
+}
+
+=head2 Squish
+
+virtual method which does nothing,
+you need to implement this method in subclasses.
+
+=cut
+
+sub Squish {
+    $RT::Logger->warn( "you need to implement this method in subclasses" );
+    return 1;
+}
+
+=head2 Content
+
+squished content
+
+=head2 Key
+
+md5 of the squished content
+
+=head2 ModifiedTime
+
+created time of squished content, i.e. seconds since 00:00:00 UTC, January 1, 1970
+
+=head2 ModifiedTimeString
+
+created time of squished content, with HTTP::Date format
+
+=cut
+
+1;
+