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