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