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