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