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