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