FS/FS/Mason.pm

   1 package FS::Mason;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK );
   5 use Exporter;
   6 use HTML::Mason 1.27; #http://www.masonhq.com/?ApacheModPerl2Redirect
   7 use HTML::Mason::Interp;
   8 use HTML::Mason::Compiler::ToObject;
   9
  10 @ISA = qw( Exporter );
  11 @EXPORT_OK = qw( mason_interps );
  12
  13 =head1 NAME
  14
  15 FS::Mason - Initialize the Mason environment
  16
  17 =head1 SYNOPSIS
  18
  19   use FS::Mason qw( mason_interps );
  20
  21   my( $fs_interp, $rt_interp ) = mason_interps('apache');
  22
  23   #OR
  24
  25   my( $fs_interp, $rt_interp ) = mason_interps('standalone'); #XXX name?
  26
  27 =head1 DESCRIPTION
  28
  29 Initializes the Mason environment, loads all Freeside and RT libraries, etc.
  30
  31 =cut
  32
  33 # List of modules that you want to use from components (see Admin
  34 # manual for details)
  35 {
  36   package HTML::Mason::Commands;
  37
  38   use strict;
  39   use vars qw( %session );
  40   use CGI 3.29 qw(-private_tempfiles); #3.29 to fix RT attachment problems
  41
  42   #breaks quick payment entry
  43   #http://rt.cpan.org/Public/Bug/Display.html?id=37365
  44   die "CGI.pm v3.38 is broken, use any other version >= 3.29".
  45       " (Debian 5.0?  aptitude remove libcgi-pm-perl)"
  46     if $CGI::VERSION == 3.38;
  47
  48   #use CGI::Carp qw(fatalsToBrowser);
  49   use CGI::Cookie;
  50   use List::Util qw( max min );
  51   use Data::Dumper;
  52   use Date::Format;
  53   use Date::Parse;
  54   use Time::Local;
  55   use Time::Duration;
  56   use DateTime;
  57   use DateTime::Format::Strptime;
  58   use Lingua::EN::Inflect qw(PL);
  59   use Tie::IxHash;
  60   use URI;
  61   use URI::Escape;
  62   use HTML::Entities;
  63   use HTML::TreeBuilder;
  64   use HTML::FormatText;
  65   use JSON;
  66   use MIME::Base64;
  67   use IO::Handle;
  68   use IO::File;
  69   use IO::Scalar;
  70   #not actually using this yet anyway...# use IPC::Run3 0.036;
  71   use Net::Whois::Raw qw(whois);
  72   if ( $] < 5.006 ) {
  73     eval "use Net::Whois::Raw 0.32 qw(whois)";
  74     die $@ if $@;
  75   }
  76   use Text::CSV_XS;
  77   use Spreadsheet::WriteExcel;
  78   use Business::CreditCard 0.30; #for mask-aware cardtype()
  79   use NetAddr::IP;
  80   use String::Approx qw(amatch);
  81   use Chart::LinesPoints;
  82   use Chart::Mountain;
  83   use Color::Scheme;
  84   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
  85                                         #selectlayers.html
  86   use Locale::Country;
  87   use Business::US::USPS::WebTools::AddressStandardization;
  88   use FS;
  89   use FS::UID qw( getotaker dbh datasrc driver_name );
  90   use FS::Record qw( qsearch qsearchs fields dbdef
  91                     str2time_sql str2time_sql_closing
  92                    );
  93   use FS::Conf;
  94   use FS::CGI qw(header menubar table itable ntable idiot
  95                  eidiot myexit http_header);
  96   use FS::UI::Web qw(svc_url);
  97   use FS::UI::Web::small_custview qw(small_custview);
  98   use FS::UI::bytecount;
  99   use FS::Msgcat qw(gettext geterror);
 100   use FS::Misc qw( send_email send_fax states_hash counties state_label );
 101   use FS::Misc::eps2png qw( eps2png );
 102   use FS::Report::Table::Monthly;
 103   use FS::TicketSystem;
 104   use FS::Tron qw( tron_lint );
 105
 106   use FS::agent;
 107   use FS::agent_type;
 108   use FS::domain_record;
 109   use FS::cust_bill;
 110   use FS::cust_bill_pay;
 111   use FS::cust_credit;
 112   use FS::cust_credit_bill;
 113   use FS::cust_main qw(smart_search);
 114   use FS::cust_main::Import;
 115   use FS::cust_main_county;
 116   use FS::cust_location;
 117   use FS::cust_pay;
 118   use FS::cust_pkg;
 119   use FS::part_pkg_taxclass;
 120   use FS::cust_pkg_reason;
 121   use FS::cust_refund;
 122   use FS::cust_credit_refund;
 123   use FS::cust_pay_refund;
 124   use FS::cust_svc;
 125   use FS::nas;
 126   use FS::part_bill_event;
 127   use FS::part_event;
 128   use FS::part_event_condition;
 129   use FS::part_pkg;
 130   use FS::part_referral;
 131   use FS::part_svc;
 132   use FS::part_svc_router;
 133   use FS::part_virtual_field;
 134   use FS::pay_batch;
 135   use FS::pkg_svc;
 136   use FS::port;
 137   use FS::queue qw(joblisting);
 138   use FS::raddb;
 139   use FS::session;
 140   use FS::svc_acct;
 141   use FS::svc_acct_pop qw(popselector);
 142   use FS::acct_rt_transaction;
 143   use FS::svc_domain;
 144   use FS::svc_forward;
 145   use FS::svc_www;
 146   use FS::router;
 147   use FS::addr_block;
 148   use FS::svc_broadband;
 149   use FS::svc_external;
 150   use FS::type_pkgs;
 151   use FS::part_export;
 152   use FS::part_export_option;
 153   use FS::export_svc;
 154   use FS::msgcat;
 155   use FS::rate;
 156   use FS::rate_region;
 157   use FS::rate_prefix;
 158   use FS::rate_detail;
 159   use FS::usage_class;
 160   use FS::payment_gateway;
 161   use FS::agent_payment_gateway;
 162   use FS::XMLRPC;
 163   use FS::payby;
 164   use FS::cdr;
 165   use FS::inventory_class;
 166   use FS::inventory_item;
 167   use FS::pkg_category;
 168   use FS::pkg_class;
 169   use FS::access_user;
 170   use FS::access_user_pref;
 171   use FS::access_group;
 172   use FS::access_usergroup;
 173   use FS::access_groupagent;
 174   use FS::access_right;
 175   use FS::AccessRight;
 176   use FS::svc_phone;
 177   use FS::phone_device;
 178   use FS::part_device;
 179   use FS::reason_type;
 180   use FS::reason;
 181   use FS::cust_main_note;
 182   use FS::tax_class;
 183   use FS::cust_tax_location;
 184   use FS::part_pkg_taxproduct;
 185   use FS::part_pkg_taxoverride;
 186   use FS::part_pkg_taxrate;
 187   use FS::tax_rate;
 188   use FS::part_pkg_report_option;
 189   use FS::h_cust_pkg;
 190   use FS::h_svc_acct;
 191   use FS::h_svc_broadband;
 192   use FS::h_svc_domain;
 193   #use FS::h_domain_record;
 194   use FS::h_svc_external;
 195   use FS::h_svc_forward;
 196   use FS::h_svc_phone;
 197   #use FS::h_phone_device;
 198   use FS::h_svc_www;
 199   # Sammath Naur
 200
 201   if ( %%%RT_ENABLED%%% ) {
 202     eval '
 203       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 204       use vars qw($Nobody $SystemUser);
 205       use RT;
 206       use RT::Tickets;
 207       use RT::Transactions;
 208       use RT::Users;
 209       use RT::CurrentUser;
 210       use RT::Templates;
 211       use RT::Queues;
 212       use RT::ScripActions;
 213       use RT::ScripConditions;
 214       use RT::Scrips;
 215       use RT::Groups;
 216       use RT::GroupMembers;
 217       use RT::CustomFields;
 218       use RT::CustomFieldValues;
 219       use RT::ObjectCustomFieldValues;
 220
 221       #blah.  manually updated from RT::Interface::Web::Handler
 222       use RT::Interface::Web;
 223       use MIME::Entity;
 224       use Text::Wrapper;
 225       use Time::ParseDate;
 226       use Time::HiRes;
 227       use HTML::Scrubber;
 228
 229       #blah.  not even in RT::Interface::Web::Handler, just in
 230       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 231       #to throw a real error instead of just a mysterious unstyled RT
 232       use CSS::Squish 0.06;
 233
 234       #slow, unreliable, segfaults and is optional
 235       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 236       use Text::Quoted;
 237
 238       #?#use File::Path qw( rmtree );
 239       #?#use File::Glob qw( bsd_glob );
 240       #?#use File::Spec::Unix;
 241
 242     ';
 243     die $@ if $@;
 244   }
 245
 246   *CGI::redirect = sub {
 247     my $self = shift;
 248     my $cookie = '';
 249     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 250       (my $x, $cookie) = (shift, shift);
 251       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 252     }
 253     my $location = shift;
 254
 255     use vars qw($m);
 256
 257     # false laziness w/below
 258     if ( defined(@DBIx::Profile::ISA) ) {
 259
 260       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 261
 262         #profiling redirect
 263
 264         my $page =
 265           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 266           '<BR><BR><PRE>'.
 267             ( UNIVERSAL::can(dbh, 'sprintProfile')
 268                 ? encode_entities(dbh->sprintProfile())
 269                 : 'DBIx::Profile missing sprintProfile method;'.
 270                   'unpatched or too old?'                        ).
 271           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 272           "\n\n".                         '</PRE>'.
 273           '</BODY></HTML>';
 274
 275
 276         dbh->{'private_profile'} = {};
 277         return $page;
 278
 279       } else {
 280
 281         #clear db profile, but normal redirect
 282         dbh->{'private_profile'} = {};
 283         $m->redirect($location);
 284         '';
 285
 286       }
 287
 288     } else { #normal redirect
 289
 290       $m->redirect($location);
 291       '';
 292
 293     }
 294
 295   };
 296
 297   sub include {
 298     use vars qw($m);
 299     $m->scomp(@_);
 300   }
 301
 302   sub errorpage {
 303     use vars qw($m);
 304     $m->comp('/elements/errorpage.html', @_);
 305   }
 306
 307   sub redirect {
 308     my( $location ) = @_;
 309     use vars qw($m);
 310     $m->clear_buffer;
 311     #false laziness w/above
 312     if ( defined(@DBIx::Profile::ISA) ) {
 313
 314       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 315
 316         #profiling redirect
 317
 318         $m->print(
 319           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 320           '<BR><BR><PRE>'.
 321             ( UNIVERSAL::can(dbh, 'sprintProfile')
 322                 ? encode_entities(dbh->sprintProfile())
 323                 : 'DBIx::Profile missing sprintProfile method;'.
 324                   'unpatched or too old?'                        ).
 325           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 326           "\n\n".                         '</PRE>'.
 327           '</BODY></HTML>'
 328         );
 329
 330         dbh->{'private_profile'} = {};
 331
 332       } else {
 333
 334         #clear db profile, but normal redirect
 335         dbh->{'private_profile'} = {};
 336         $m->redirect($location);
 337
 338       }
 339
 340     } else { #normal redirect
 341
 342       $m->redirect($location);
 343
 344     }
 345
 346   }
 347
 348 } # end package HTML::Mason::Commands;
 349
 350 =head1 SUBROUTINE
 351
 352 =over 4
 353
 354 =item mason_interps [ MODE ]
 355
 356 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 357 Freeside pages, and the second for RT pages.
 358
 359 #MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 360
 361 =cut
 362
 363 sub mason_interps {
 364   my $mode = shift || 'apache';
 365   my %opt = @_;
 366
 367   #my $request_class = 'HTML::Mason::Request'.
 368                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 369   my $request_class = 'FS::Mason::Request';
 370
 371   #not entirely sure it belongs here, but what the hey
 372   if ( %%%RT_ENABLED%%% ) {
 373     RT::LoadConfig();
 374   }
 375
 376   my %interp = (
 377     request_class        => $request_class,
 378     data_dir             => '%%%MASONDATA%%%',
 379     error_mode           => 'output',
 380     error_format         => 'html',
 381     ignore_warnings_expr => '.',
 382     comp_root            => [
 383                               [ 'freeside'=>'%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 384                               [ 'rt'      =>'%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 385                             ],
 386   );
 387
 388   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 389
 390   my $fs_interp = new HTML::Mason::Interp (
 391     %interp,
 392     escape_flags => { 'js_string' => sub {
 393                         #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 394                         ${$_[0]} =~ s/(['\\])/\\$1/g;
 395                         ${$_[0]} =~ s/\n/\\n/g;
 396                         ${$_[0]} = "'". ${$_[0]}. "'";
 397                       }
 398                     },
 399     compiler     => HTML::Mason::Compiler::ToObject->new(
 400                       allow_globals        => [qw(%session)],
 401                     ),
 402   );
 403
 404   my $rt_interp = new HTML::Mason::Interp (
 405     %interp,
 406     escape_flags => { 'h' => \&RT::Interface::Web::EscapeUTF8 },
 407     compiler     => HTML::Mason::Compiler::ToObject->new(
 408                       default_escape_flags => 'h',
 409                       allow_globals        => [qw(%session)],
 410                     ),
 411   );
 412
 413   ( $fs_interp, $rt_interp );
 414
 415 }
 416
 417 =back
 418
 419 =head1 BUGS
 420
 421 Lurking in the darkness...
 422
 423 =head1 SEE ALSO
 424
 425 L<HTML::Mason>, L<FS>, L<RT>
 426
 427 =cut
 428
 429 1;