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