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