fix problems using inventory for UID (and other fields controlled by check in svc_acc...
[freeside.git] / FS / FS / CGI.pm
1 package FS::CGI;
2
3 use strict;
4 use vars qw(@EXPORT_OK @ISA);
5 use Exporter;
6 use CGI;
7 use URI::URL;
8 #use CGI::Carp qw(fatalsToBrowser);
9 use FS::UID;
10
11 @ISA = qw(Exporter);
12 @EXPORT_OK = qw( header menubar idiot eidiot popurl rooturl table itable ntable
13                  myexit http_header);
14
15 =head1 NAME
16
17 FS::CGI - Subroutines for the web interface
18
19 =head1 SYNOPSIS
20
21   use FS::CGI qw(header menubar idiot eidiot popurl);
22
23   print header( 'Title', '' );
24   print header( 'Title', menubar('item', 'URL', ... ) );
25
26   idiot "error message"; 
27   eidiot "error message";
28
29   $url = popurl; #returns current url
30   $url = popurl(3); #three levels up
31
32 =head1 DESCRIPTION
33
34 Provides a few common subroutines for the web interface.
35
36 =head1 SUBROUTINES
37
38 =over 4
39
40 =item header TITLE, MENUBAR
41
42 Returns an HTML header.
43
44 =cut
45
46 sub header {
47   use Carp;
48   carp 'FS::CGI::header deprecated; include /elements/header.html instead';
49
50   my($title,$menubar,$etc)=@_; #$etc is for things like onLoad= etc.
51   $etc = '' unless defined $etc;
52
53   my $x =  <<END;
54     <HTML>
55       <HEAD>
56         <TITLE>
57           $title
58         </TITLE>
59         <META HTTP-Equiv="Cache-Control" Content="no-cache">
60         <META HTTP-Equiv="Pragma" Content="no-cache">
61         <META HTTP-Equiv="Expires" Content="0"> 
62       </HEAD>
63       <BODY BGCOLOR="#e8e8e8"$etc>
64           <FONT SIZE=6>
65             <CENTER>$title</CENTER>
66           </FONT>
67           <BR><!--<BR>-->
68 END
69   $x .=  $menubar. "<BR><BR>" if $menubar;
70   $x;
71 }
72
73 =item http_header
74
75 Sets an http header.
76
77 =cut
78
79 sub http_header {
80   my ( $header, $value ) = @_;
81   if (exists $ENV{MOD_PERL}) {
82     if ( defined $HTML::Mason::Commands::r  ) { #Mason
83       ## is this the correct pacakge for $r ???  for 1.0x and 1.1x ?
84       if ( $header =~ /^Content-Type$/ ) {
85         $HTML::Mason::Commands::r->content_type($value);
86       } else {
87         $HTML::Mason::Commands::r->header_out( $header => $value );
88       }
89     } else {
90       die "http_header called in unknown environment";
91     }
92   } else {
93     die "http_header called not running under mod_perl";
94   }
95
96 }
97
98 =item menubar ITEM, URL, ...
99
100 Returns an HTML menubar.
101
102 =cut
103
104 sub menubar { #$menubar=menubar('Main Menu', '../', 'Item', 'url', ... );
105   use Carp;
106   carp 'FS::CGI::menubar deprecated; include /elements/menubar.html instead';
107
108   my($item,$url,@html);
109   while (@_) {
110     ($item,$url)=splice(@_,0,2);
111     next if $item =~ /^\s*Main\s+Menu\s*$/i;
112     push @html, qq!<A HREF="$url">$item</A>!;
113   }
114   join(' | ',@html);
115 }
116
117 =item idiot ERROR
118
119 This is depriciated.  Don't use it.
120
121 Sends an HTML error message.
122
123 =cut
124
125 sub idiot {
126   #warn "idiot depriciated";
127   my($error)=@_;
128 #  my $cgi = &FS::UID::cgi();
129 #  if ( $cgi->isa('CGI::Base') ) {
130 #    no strict 'subs';
131 #    &CGI::Base::SendHeaders;
132 #  } else {
133 #    print $cgi->header( @FS::CGI::header );
134 #  }
135   print <<END;
136 <HTML>
137   <HEAD>
138     <TITLE>Error processing your request</TITLE>
139     <META HTTP-Equiv="Cache-Control" Content="no-cache">
140     <META HTTP-Equiv="Pragma" Content="no-cache">
141     <META HTTP-Equiv="Expires" Content="0"> 
142   </HEAD>
143   <BODY>
144     <CENTER>
145     <H4>Error processing your request</H4>
146     </CENTER>
147     Your request could not be processed because of the following error:
148     <P><B>$error</B>
149   </BODY>
150 </HTML>
151 END
152
153 }
154
155 =item eidiot ERROR
156
157 This is depriciated.  Don't use it.
158
159 Sends an HTML error message, then exits.
160
161 =cut
162
163 sub eidiot {
164   warn "eidiot depriciated";
165   $HTML::Mason::Commands::r->send_http_header
166     if defined $HTML::Mason::Commands::r;
167   idiot(@_);
168   &myexit();
169 }
170
171 =item myexit
172
173 You probably shouldn't use this; but if you must:
174
175 If running under mod_perl, calles Apache::exit, otherwise, calls exit.
176
177 =cut
178
179 sub myexit {
180   if (exists $ENV{MOD_PERL}) {
181
182     if ( defined $HTML::Mason::Commands::m  ) { #Mason
183       #$HTML::Mason::Commands::m->flush_buffer();
184       $HTML::Mason::Commands::m->abort();
185       die "shouldn't fall through to here (mason \$m->abort didn't)";
186     } else {
187       #??? well, it is $ENV{MOD_PERL}
188       warn "running under unknown mod_perl environment; trying Apache::exit()";
189       require Apache;
190       Apache::exit();
191     }
192   } else {
193     exit;
194   }
195 }
196
197 =item popurl LEVEL [URL]
198
199 Returns current (or, optionally, passed) URL with LEVEL levels of path removed
200 from the end (default 0).
201
202 =cut
203
204 sub popurl {
205   my $up = shift;
206
207   my $url_string;
208   if ( scalar(@_) ) {
209     $url_string = shift;
210   } else {
211     my $cgi = &FS::UID::cgi;
212     $url_string = $cgi->isa('Apache') ? $cgi->uri : $cgi->url;
213   }
214
215   $url_string =~ s/\?.*//;
216   my $url = new URI::URL ( $url_string );
217   my(@path)=$url->path_components;
218   splice @path, 0-$up;
219   $url->path_components(@path);
220   my $x = $url->as_string;
221   $x .= '/' unless $x =~ /\/$/;
222   $x;
223 }
224
225 =item rooturl 
226
227 =cut
228
229 sub rooturl {
230   # better to start with the client-provided URL
231   my $cgi = &FS::UID::cgi;
232   my $url_string = $cgi->isa('Apache') ? $cgi->uri : $cgi->url;
233   $url_string =~ s/\?.*//;
234
235   #even though this is kludgy
236   $url_string =~ s{ / index\.html /? $ }
237                   {/}x;
238   $url_string =~
239     s{
240        /
241        (browse|config|docs|edit|graph|misc|search|view|pref|rt|elements)
242        /
243        (process/)?
244        ([\w\-\.\/]*)
245        $
246      }
247      {}x;
248
249   #elements because of progress-popup.html... 
250   #XXX remove anything from elements that is called directly & prevent
251   #those pages from being served up
252
253   $url_string .= '/' unless $url_string =~ /\/$/;
254
255   $url_string;
256
257 }
258
259 =item table
260
261 Returns HTML tag for beginning a table.
262
263 =cut
264
265 sub table {
266   use Carp;
267   carp 'FS::CGI::table deprecated; include /elements/table.html instead';
268
269   my $col = shift;
270   if ( $col ) {
271     qq!<TABLE BGCOLOR="$col" BORDER=1 WIDTH="100%" CELLSPACING=0 CELLPADDING=2 BORDERCOLOR="#999999">!;
272   } else { 
273     '<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2 BORDERCOLOR="#999999">';
274   }
275 }
276
277 =item itable
278
279 Returns HTML tag for beginning an (invisible) table.
280
281 =cut
282
283 sub itable {
284   my $col = shift;
285   my $cellspacing = shift || 0;
286   my $width = ( scalar(@_) && shift ) ? '' : 'WIDTH="100%"';  #bah
287   if ( $col ) {
288     qq!<TABLE BGCOLOR="$col" BORDER=0 CELLSPACING=$cellspacing $width>!;
289   } else {
290     qq!<TABLE BORDER=0 CELLSPACING=$cellspacing $width>!;
291   }
292 }
293
294 =item ntable
295
296 This is getting silly.
297
298 =cut
299
300 sub ntable {
301   my $col = shift;
302   my $cellspacing = shift || 0;
303   if ( $col ) {
304     qq!<TABLE BGCOLOR="$col" BORDER=0 CELLSPACING=$cellspacing>!;
305   } else {
306     '<TABLE BORDER CELLSPACING=0 CELLPADDING=2 BORDERCOLOR="#999999">';
307   }
308
309 }
310
311 =back
312
313 =head1 BUGS
314
315 Not OO.
316
317 Not complete.
318
319 =head1 SEE ALSO
320
321 L<CGI>, L<CGI::Base>
322
323 =cut
324
325 1;
326
327