FS/FS/Mason.pm

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