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 sum );
  59   use List::MoreUtils qw( first_index uniq );
  60   use Scalar::Util qw( blessed looks_like_number );
  61   use Data::Dumper;
  62   use Date::Format;
  63   use Time::Local;
  64   use Time::HiRes;
  65   use Time::Duration;
  66   use DateTime;
  67   use DateTime::Format::Strptime;
  68   use FS::Misc::DateTime qw( parse_datetime );
  69   use FS::Misc::Geo qw( get_district );
  70   use Lingua::EN::Inflect qw(PL);
  71   Lingua::EN::Inflect::classical names=>0; #Categorys
  72   use Tie::IxHash;
  73   use URI;
  74   use URI::Escape 3.31;
  75   use HTML::Entities;
  76   use HTML::TreeBuilder;
  77   use HTML::TableExtract qw(tree);
  78   use HTML::FormatText;
  79   use HTML::Defang;
  80   use JSON::XS;
  81 #  use XMLRPC::Transport::HTTP;
  82 #  use XMLRPC::Lite; # for XMLRPC::Serializer
  83   use MIME::Base64;
  84   use IO::Handle;
  85   use IO::File;
  86   use IO::Scalar;
  87   use IO::String;
  88   use File::Slurp qw( slurp );
  89   #not actually using this yet anyway...# use IPC::Run3 0.036;
  90   use Net::Whois::Raw qw(whois);
  91   if ( $] < 5.006 ) {
  92     eval "use Net::Whois::Raw 0.32 qw(whois)";
  93     die $@ if $@;
  94   }
  95   use Text::CSV_XS;
  96   use Spreadsheet::WriteExcel;
  97   use Spreadsheet::WriteExcel::Utility;
  98   use OLE::Storage_Lite;
  99   use Excel::Writer::XLSX;
 100   #use Excel::Writer::XLSX::Utility; #redundant with above
 101
 102   use Business::CreditCard 0.30; #for mask-aware cardtype()
 103   use NetAddr::IP;
 104   use Net::MAC::Vendor;
 105   use Net::Ping;
 106   use Net::Ping::External;
 107   #if CPAN #7815 ever gets fixed# if ( $Net::Ping::External::VERSION <= 0.12 )
 108   {
 109     no warnings 'redefine';
 110     eval 'sub Net::Ping::External::_ping_linux {
 111             my %args = @_;
 112             my $command = "ping -s $args{size} -c $args{count} -w $args{timeout} $args{host}";
 113             return Net::Ping::External::_ping_system($command, 0);
 114           }
 115          ';
 116     die $@ if $@;
 117   }
 118   use String::Approx qw(amatch);
 119   use Chart::LinesPoints;
 120   use Chart::Mountain;
 121   use Chart::Bars;
 122   use Color::Scheme;
 123   use HTML::Widgets::SelectLayers 0.07; #should go away in favor of
 124                                         #selectlayers.html
 125   use Locale::Country;
 126   use Business::US::USPS::WebTools::AddressStandardization;
 127   use Geo::GoogleEarth::Pluggable;
 128   use LWP::UserAgent;
 129   use Storable qw( nfreeze thaw );
 130   use FS;
 131   use FS::UID qw( getotaker dbh datasrc driver_name );
 132   use FS::Record qw( qsearch qsearchs fields dbdef
 133                     str2time_sql str2time_sql_closing
 134                     midnight_sql regexp_sql
 135                    );
 136   use FS::Conf;
 137   use FS::CGI qw(header menubar table itable ntable idiot
 138                  eidiot myexit http_header);
 139   use FS::UI::Web qw(svc_url random_id);
 140   use FS::UI::Web::small_custview qw(small_custview);
 141   use FS::UI::bytecount;
 142   use FS::Msgcat qw(gettext geterror);
 143   use FS::Misc qw( send_email send_fax ocr_image
 144                    states_hash counties cities state_label
 145                    card_types
 146                  );
 147   use FS::Misc::eps2png qw( eps2png );
 148   use FS::Report::FCC_477;
 149   use FS::Report::Table;
 150   use FS::Report::Table::Monthly;
 151   use FS::Report::Table::Daily;
 152   use FS::Report::Tax;
 153   use FS::TicketSystem;
 154   use FS::NetworkMonitoringSystem;
 155   use FS::Tron qw( tron_lint );
 156   use FS::Locales;
 157   use FS::Maketext qw( mt emt js_mt );
 158
 159   use FS::Query;
 160
 161   use FS::agent;
 162   use FS::agent_type;
 163   use FS::domain_record;
 164   use FS::cust_bill;
 165   use FS::cust_bill_pay;
 166   use FS::cust_credit;
 167   use FS::cust_credit_bill;
 168   use FS::cust_main;
 169   use FS::h_cust_main;
 170   use FS::cust_main::Search qw(smart_search);
 171   use FS::cust_main::Import;
 172   use FS::cust_main_county;
 173   use FS::cust_location;
 174   use FS::cust_pay;
 175   use FS::cust_pkg;
 176   use FS::cust_pkg::Import;
 177   use FS::part_pkg_taxclass;
 178   use FS::cust_pkg_reason;
 179   use FS::cust_refund;
 180   use FS::cust_credit_refund;
 181   use FS::cust_pay_refund;
 182   use FS::cust_svc;
 183   use FS::nas;
 184   use FS::part_bill_event;
 185   use FS::part_event;
 186   use FS::part_event_condition;
 187   use FS::part_pkg;
 188   use FS::part_referral;
 189   use FS::part_svc;
 190   use FS::part_svc_router;
 191   use FS::part_virtual_field;
 192   use FS::pay_batch;
 193   use FS::pkg_svc;
 194   use FS::port;
 195   use FS::queue qw(joblisting);
 196   use FS::raddb;
 197   use FS::session;
 198   use FS::svc_acct;
 199   use FS::svc_acct_pop qw(popselector);
 200   use FS::acct_rt_transaction;
 201   use FS::svc_domain;
 202   use FS::svc_forward;
 203   use FS::svc_www;
 204   use FS::router;
 205   use FS::addr_block;
 206   use FS::svc_broadband;
 207   use FS::svc_external;
 208   use FS::type_pkgs;
 209   use FS::part_export;
 210   use FS::part_export_option;
 211   use FS::export_svc;
 212   use FS::export_device;
 213   use FS::msgcat;
 214   use FS::rate;
 215   use FS::rate_region;
 216   use FS::rate_prefix;
 217   use FS::rate_detail;
 218   use FS::usage_class;
 219   use FS::payment_gateway;
 220   use FS::agent_payment_gateway;
 221   use FS::XMLRPC;
 222   use FS::payby;
 223   use FS::cdr;
 224   use FS::cdr_batch;
 225   use FS::inventory_class;
 226   use FS::inventory_item;
 227   use FS::pkg_category;
 228   use FS::pkg_class;
 229   use FS::access_user;
 230   use FS::access_user_pref;
 231   use FS::access_group;
 232   use FS::access_usergroup;
 233   use FS::access_groupagent;
 234   use FS::access_right;
 235   use FS::AccessRight;
 236   use FS::svc_phone;
 237   use FS::phone_device;
 238   use FS::part_device;
 239   use FS::reason_type;
 240   use FS::reason;
 241   use FS::cust_main_note;
 242   use FS::tax_class;
 243   use FS::cust_tax_location;
 244   use FS::part_pkg_taxproduct;
 245   use FS::part_pkg_taxoverride;
 246   use FS::part_pkg_taxrate;
 247   use FS::tax_rate;
 248   use FS::part_pkg_report_option;
 249   use FS::cust_attachment;
 250   use FS::h_cust_pkg;
 251   use FS::h_inventory_item;
 252   use FS::h_svc_acct;
 253   use FS::h_svc_broadband;
 254   use FS::h_svc_domain;
 255   #use FS::h_domain_record;
 256   use FS::h_svc_external;
 257   use FS::h_svc_forward;
 258   use FS::h_svc_phone;
 259   #use FS::h_phone_device;
 260   use FS::h_svc_www;
 261   use FS::cust_statement;
 262   use FS::cust_class;
 263   use FS::cust_category;
 264   use FS::prospect_main;
 265   use FS::contact;
 266   use FS::phone_type;
 267   use FS::svc_pbx;
 268   use FS::discount;
 269   use FS::cust_pkg_discount;
 270   use FS::cust_bill_pkg_discount;
 271   use FS::svc_mailinglist;
 272   use FS::cgp_rule;
 273   use FS::cgp_rule_condition;
 274   use FS::cgp_rule_action;
 275   use FS::bill_batch;
 276   use FS::cust_bill_batch;
 277   use FS::rate_time;
 278   use FS::rate_time_interval;
 279   use FS::msg_template;
 280   use FS::part_tag;
 281   use FS::acct_snarf;
 282   use FS::part_pkg_discount;
 283   use FS::svc_cert;
 284   use FS::svc_dsl;
 285   use FS::qual;
 286   use FS::qual_option;
 287   use FS::dsl_note;
 288   use FS::part_pkg_vendor;
 289   use FS::cust_note_class;
 290   use FS::svc_port;
 291   use FS::lata;
 292   use FS::did_vendor;
 293   use FS::did_order;
 294   use FS::torrus_srvderive;
 295   use FS::torrus_srvderive_component;
 296   use FS::areacode;
 297   use FS::svc_dish;
 298   use FS::h_svc_dish;
 299   use FS::svc_hardware;
 300   use FS::h_svc_hardware;
 301   use FS::hardware_class;
 302   use FS::hardware_type;
 303   use FS::hardware_status;
 304   use FS::did_order_item;
 305   use FS::msa;
 306   use FS::rate_center;
 307   use FS::cust_msg;
 308   use FS::radius_group;
 309   use FS::template_content;
 310   use FS::dsl_device;
 311   use FS::nas;
 312   use FS::nas;
 313   use FS::export_nas;
 314   use FS::legacy_cust_bill;
 315   use FS::rate_tier;
 316   use FS::rate_tier_detail;
 317   use FS::radius_attr;
 318   use FS::discount_plan;
 319   use FS::tower;
 320   use FS::tower_sector;
 321   use FS::sales;
 322   use FS::contact_class;
 323   use FS::part_svc_class;
 324   use FS::upload_target;
 325   use FS::quotation;
 326   use FS::quotation_pkg;
 327   use FS::quotation_pkg_discount;
 328   use FS::cust_bill_void;
 329   use FS::cust_bill_pkg_void;
 330   use FS::cust_bill_pkg_detail_void;
 331   use FS::cust_bill_pkg_display_void;
 332   use FS::cust_bill_pkg_tax_location_void;
 333   use FS::cust_bill_pkg_tax_rate_location_void;
 334   use FS::cust_tax_exempt_pkg_void;
 335   use FS::cust_bill_pkg_discount_void;
 336   use FS::agent_pkg_class;
 337   use FS::svc_export_machine;
 338   use FS::GeocodeCache;
 339   use FS::log;
 340   use FS::log_context;
 341   use FS::part_pkg_usage_class;
 342   use FS::cust_pkg_usage;
 343   use FS::part_pkg_usage_class;
 344   use FS::part_pkg_usage;
 345   use FS::cdr_cust_pkg_usage;
 346   use FS::part_pkg_msgcat;
 347   use FS::svc_cable;
 348   use FS::sales_pkg_class;
 349   use FS::svc_alarm;
 350   use FS::cable_model;
 351   use FS::invoice_mode;
 352   use FS::invoice_conf;
 353   use FS::cable_provider;
 354   use FS::cust_credit_void;
 355   use FS::discount_class;
 356   use FS::alarm_system;
 357   use FS::alarm_type;
 358   use FS::alarm_station;
 359   use FS::addr_range;
 360   use FS::pbx_extension;
 361   use FS::cust_event_fee;
 362   use FS::part_fee;
 363   use FS::cust_bill_pkg_fee;
 364   use FS::part_fee_msgcat;
 365   use FS::part_fee_usage;
 366   use FS::sched_item;
 367   use FS::sched_avail;
 368   use FS::export_batch;
 369   use FS::export_batch_item;
 370   use FS::part_pkg_fcc_option;
 371   use FS::state;
 372   use FS::queue_stat;
 373   use FS::deploy_zone;
 374   use FS::deploy_zone_block;
 375   use FS::deploy_zone_vertex;
 376   use FS::circuit_type;
 377   use FS::circuit_provider;
 378   use FS::circuit_termination;
 379   use FS::svc_circuit;
 380   use FS::legacy_cust_history;
 381   use FS::quotation_pkg_tax;
 382   use FS::cust_pkg_reason_fee;
 383   use FS::access_user_log;
 384   use FS::report_batch;
 385   use FS::report_batch;
 386   use FS::report_batch;
 387   use FS::report_batch;
 388   use FS::password_history;
 389   use FS::svc_fiber;
 390   use FS::fiber_olt;
 391   # Sammath Naur
 392
 393   if ( $FS::Mason::addl_handler_use ) {
 394     eval $FS::Mason::addl_handler_use;
 395     die $@ if $@;
 396   }
 397
 398   if ( %%%RT_ENABLED%%% ) {
 399     eval '
 400       use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 401       use vars qw($Nobody $SystemUser);
 402       use RT;
 403       use RT::Util;
 404       use RT::Tickets;
 405       use RT::Transactions;
 406       use RT::Users;
 407       use RT::CurrentUser;
 408       use RT::Templates;
 409       use RT::Queues;
 410       use RT::ScripActions;
 411       use RT::ScripConditions;
 412       use RT::Scrips;
 413       use RT::Groups;
 414       use RT::GroupMembers;
 415       use RT::CustomFields;
 416       use RT::CustomFieldValues;
 417       use RT::ObjectCustomFieldValues;
 418
 419       #blah.  manually updated from RT::Interface::Web::Handler
 420       use RT::Interface::Web;
 421       use MIME::Entity;
 422       use Text::Wrapper;
 423       use Time::ParseDate;
 424       use Time::HiRes;
 425       use HTML::Scrubber;
 426
 427       #blah.  not even in RT::Interface::Web::Handler, just in
 428       #html/NoAuth/css/dhandler and rt-test-dependencies.  ask for it here
 429       #to throw a real error instead of just a mysterious unstyled RT
 430       use CSS::Squish 0.06;
 431
 432       use RT::Interface::Web::Request;
 433
 434       #another undeclared web UI dep (for ticket links graph)
 435       use IPC::Run::SafeHandles;
 436
 437       #slow, unreliable, segfaults and is optional
 438       #see rt/html/Ticket/Elements/ShowTransactionAttachments
 439       #use Text::Quoted;
 440
 441       #?#use File::Path qw( rmtree );
 442       #?#use File::Glob qw( bsd_glob );
 443       #?#use File::Spec::Unix;
 444
 445     ';
 446     die $@ if $@;
 447   }
 448
 449   no warnings 'redefine';
 450   *CGI::redirect = sub {
 451     my $self = shift;
 452     my $cookie = '';
 453     if ( $_[0] eq '-cookie' ) { #this isn't actually used at the moment
 454       (my $x, $cookie) = (shift, shift);
 455       $HTML::Mason::r->err_headers_out->add( 'Set-cookie' => $cookie );
 456     }
 457     my $location = shift;
 458
 459     use vars qw($m);
 460
 461     # false laziness w/below
 462     if ( defined(@DBIx::Profile::ISA) ) {
 463
 464       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 465
 466         #profiling redirect
 467
 468         my $page =
 469           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 470           '<BR><BR><PRE>'.
 471             ( UNIVERSAL::can(dbh, 'sprintProfile')
 472                 ? encode_entities(dbh->sprintProfile())
 473                 : 'DBIx::Profile missing sprintProfile method;'.
 474                   'unpatched or too old?'                        ).
 475           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 476           "\n\n".                         '</PRE>'.
 477           '</BODY></HTML>';
 478
 479
 480         dbh->{'private_profile'} = {};
 481         return $page;
 482
 483       } else {
 484
 485         #clear db profile, but normal redirect
 486         dbh->{'private_profile'} = {};
 487         $m->redirect($location);
 488         '';
 489
 490       }
 491
 492     } else { #normal redirect
 493
 494       $m->redirect($location);
 495       '';
 496
 497     }
 498
 499   };
 500
 501   sub include {
 502     use vars qw($m);
 503     #carp #should just switch to <& &> syntax
 504     $m->scomp(@_);
 505   }
 506
 507   sub errorpage {
 508     use vars qw($m);
 509     $m->comp('/elements/errorpage.html', @_);
 510   }
 511
 512   sub errorpage_popup {
 513     use vars qw($m);
 514     $m->comp('/elements/errorpage-popup.html', @_);
 515   }
 516
 517   sub redirect {
 518     my( $location ) = @_;
 519     use vars qw($m);
 520     $m->clear_buffer;
 521     #false laziness w/above
 522     if ( defined(@DBIx::Profile::ISA) ) {
 523
 524       if ( $FS::CurrentUser::CurrentUser->option('show_db_profile') ) {
 525
 526         #profiling redirect
 527
 528         $m->print(
 529           qq!<HTML><BODY>Redirect to <A HREF="$location">$location</A>!.
 530           '<BR><BR><PRE>'.
 531             ( UNIVERSAL::can(dbh, 'sprintProfile')
 532                 ? encode_entities(dbh->sprintProfile())
 533                 : 'DBIx::Profile missing sprintProfile method;'.
 534                   'unpatched or too old?'                        ).
 535           #"\n\n". &sprintAutoProfile().  '</PRE>'.
 536           "\n\n".                         '</PRE>'.
 537           '</BODY></HTML>'
 538         );
 539
 540         dbh->{'private_profile'} = {};
 541
 542       } else {
 543
 544         #clear db profile, but normal redirect
 545         dbh->{'private_profile'} = {};
 546         $m->redirect($location);
 547
 548       }
 549
 550     } else { #normal redirect
 551
 552       $m->redirect($location);
 553
 554     }
 555
 556   }
 557
 558 } # end package HTML::Mason::Commands;
 559
 560 =head1 SUBROUTINE
 561
 562 =over 4
 563
 564 =item mason_interps [ MODE [ OPTION => VALUE ... ] ]
 565
 566 Returns a list consisting of two HTML::Mason::Interp objects, the first for
 567 Freeside pages, and the second for RT pages.
 568
 569 MODE can be 'apache' or 'standalone'.  If not specified, defaults to 'apache'.
 570
 571 Options and values can be passed following mode.  Currently available options
 572 are:
 573
 574 I<outbuf> should be set to a scalar reference in standalone mode.
 575
 576 =cut
 577
 578 my %defang_opts = ( attribs_to_callback => ['src'], attribs_callback => sub { 1 });
 579
 580 sub mason_interps {
 581   my $mode = shift || 'apache';
 582   my %opt = @_;
 583
 584   #my $request_class = 'HTML::Mason::Request'.
 585                       #( $mode eq 'apache' ? '::ApacheHandler' : '' );
 586   my $request_class = $mode eq 'standalone' ? 'FS::Mason::StandaloneRequest'
 587                                             : 'FS::Mason::Request';
 588
 589   #not entirely sure it belongs here, but what the hey
 590   if ( %%%RT_ENABLED%%% && $mode ne 'standalone' ) {
 591     RT::LoadConfig();
 592   }
 593
 594   my $fs_comp_root = '%%%FREESIDE_DOCUMENT_ROOT%%%';
 595
 596   my %interp = (
 597     request_class        => $request_class,
 598     data_dir             => '%%%MASONDATA%%%',
 599     error_mode           => 'output',
 600     error_format         => 'html',
 601     ignore_warnings_expr => '.',
 602   );
 603
 604   $interp{out_method} = $opt{outbuf} if $mode eq 'standalone' && $opt{outbuf};
 605
 606   my $html_defang = new HTML::Defang (%defang_opts);
 607
 608   #false laziness w/ FS::Maketext js_mt
 609   my $js_string_sub = sub {
 610     #${$_[0]} =~ s/(['\\\n])/'\\'.($1 eq "\n" ? 'n' : $1)/ge;
 611     ${$_[0]} =~ s/(['\\])/\\$1/g;
 612     ${$_[0]} =~ s/\r/\\r/g;
 613     ${$_[0]} =~ s/\n/\\n/g;
 614     # prevent premature termination of the script
 615     ${$_[0]} =~ s[</script>][<\\/script>]ig;
 616     ${$_[0]} = "'". ${$_[0]}. "'";
 617   };
 618
 619   my $defang_sub = sub {
 620     ${$_[0]} = $html_defang->defang(${$_[0]});
 621   };
 622
 623   my $fs_interp = new HTML::Mason::Interp (
 624     %interp,
 625     comp_root    => $fs_comp_root,
 626     escape_flags => { 'js_string'   => $js_string_sub,
 627                       'defang'      => $defang_sub,
 628                     },
 629     compiler     => HTML::Mason::Compiler::ToObject->new(
 630                       allow_globals        => [qw(%session)],
 631                     ),
 632   );
 633
 634   my $rt_interp = new HTML::Mason::Interp (
 635     %interp,
 636     comp_root    => [
 637                       [ 'rt'       => '%%%FREESIDE_DOCUMENT_ROOT%%%/rt' ],
 638                       [ 'freeside' => '%%%FREESIDE_DOCUMENT_ROOT%%%'    ],
 639                     ],
 640     escape_flags => { 'h'         => \&RT::Interface::Web::EscapeUTF8,
 641                       'u'         => \&RT::Interface::Web::EscapeURI,
 642                       'j'         => \&RT::Interface::Web::EscapeJS,
 643                       'js_string' => $js_string_sub,
 644                     },
 645     compiler     => HTML::Mason::Compiler::ToObject->new(
 646                       default_escape_flags => 'h',
 647                       allow_globals        => [qw(%session $DECODED_ARGS)],
 648                     ),
 649   );
 650
 651   ( $fs_interp, $rt_interp );
 652
 653 }
 654
 655 =back
 656
 657 =head1 BUGS
 658
 659 Lurking in the darkness...
 660
 661 =head1 SEE ALSO
 662
 663 L<HTML::Mason>, L<FS>, L<RT>
 664
 665 =cut
 666
 667 1;