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