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