A little UTF-8 never killed anybody
[isso.git] / printer.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 /**
23 * Printer
24 * printer.php
25 *
26 * @package ISSO
27 */
28
29 /**
30 * Printer
31 *
32 * This framework generates standard HTML through various functions. The purpose
33 * is generally so that things like the admin system can be created without templates.
34 *
35 * @author Iris Studios, Inc.
36 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
37 * @version $Revision$
38 * @package ISSO
39 *
40 */
41 class Printer
42 {
43 /**
44 * Framework registry object
45 * @var object
46 */
47 var $registry = null;
48
49 /**
50 * Realm that we are operating in (displayed in the <title>)
51 * @var string
52 */
53 var $realm = '[UNDEFINED REALM]';
54
55 /**
56 * CSS to place in the page
57 * @var string
58 */
59 var $css = '';
60
61 // ###################################################################
62 /**
63 * Constructor
64 */
65 function __construct(&$registry)
66 {
67 $this->registry =& $registry;
68 }
69
70 // ###################################################################
71 /**
72 * (PHP 4) Constructor
73 */
74 function Printer(&$registry)
75 {
76 $this->__construct($registry);
77 }
78
79 // ###################################################################
80 /**
81 * Creates a redirect to another page; constructs the header and footer
82 * (therefore execution stops)
83 *
84 * @access public
85 *
86 * @param string Location to redirect to
87 * @param integer Time to wait before the redirect
88 * @param array An aray of POST variables to send through on the redirect
89 */
90 function redirect($location, $timeout = 10, $postvars = array())
91 {
92 $timeout = $timeout * 200;
93
94 if ($postvars)
95 {
96 $js = <<<JS
97 <script type="text/javascript">
98 <!--
99 var timeout = $timeout;
100
101 if (timeout > 0)
102 {
103 setTimeout("redirect()", $timeout);
104 }
105 else
106 {
107 redirect();
108 }
109
110 function redirect()
111 {
112 document.forms.postvars.submit();
113 }
114
115 //-->
116 </script>
117 JS;
118 }
119 else
120 {
121 $js = <<<JS
122 <script type="text/javascript">
123 <!--
124 var timeout = $timeout;
125
126 if (timeout > 0)
127 {
128 setTimeout("redirect()", $timeout);
129 }
130 else
131 {
132 redirect();
133 }
134
135 function redirect()
136 {
137 window.location = "$location";
138 }
139 //-->
140 </script>
141 JS;
142 }
143
144 $this->page_start($this->registry->modules['localize']->string('Redirect'));
145
146 if ($postvars)
147 {
148 $this->form_start($location, null, false, 'postvars');
149
150 foreach ($postvars AS $key => $value)
151 {
152 $this->form_hidden_field($key, $value);
153 }
154
155 $this->form_end();
156 }
157
158 $this->page_message($this->registry->modules['localize']->string('Redirect'), sprintf($this->registry->modules['localize']->string('Please wait to be redirected. If you are not redirected in a few seconds, click <a href="%1$s">here</a>.'), $location));
159
160 $this->page_code($js);
161
162 $this->page_end();
163 }
164
165 // ###################################################################
166 /**
167 * Throws a fatal error; constructs the header and footer
168 *
169 * @access public
170 *
171 * @param string Error messsage text
172 */
173 function error($message)
174 {
175 $this->page_start($this->registry->modules['localize']->string('Error'));
176 $this->page_message($this->registry->modules['localize']->string('Error'), $message);
177 $this->page_end();
178
179 exit;
180 }
181
182 // ###################################################################
183 /**
184 * Outputs the header of the page: doctype, <html>, <head>, <title>,
185 * <body> and imbeds the style information
186 *
187 * @access public
188 *
189 * @param string Title of the page
190 * @param string Class of the page to be applied to the body
191 * @param integer Margin of the <div> that all content is placed in
192 * @param string Extra HTML to imbed in the <head> tag
193 * @param string <body> onLoad action to imbed
194 * @param integer Margin of the actual <body > tag
195 * @param string Relative path where the CSS data is stored
196 * @param bool Will force re-print the header if it has already been printed
197 */
198 function page_start($actiontitle, $pageclass = ':default:', $pagemargin = 15, $extra = '', $onload = false, $margin = 0, $dotpath = '.', $override = false)
199 {
200 if ($this->registry->debug AND isset($_GET['query']))
201 {
202 ob_start();
203 }
204
205 if (defined('DONE_HEADER') AND !$override)
206 {
207 if (constant('DONE_HEADER') AND !$override)
208 {
209 return;
210 }
211 }
212
213 $title = sprintf($this->registry->modules['localize']->string('%1$s - %2$s - %3$s'), $this->registry->application, $this->realm, $actiontitle);
214
215 echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
216 echo "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>";
217 echo "\n\t<title>$title</title>";
218 echo "\n\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />";
219 echo $this->css;
220 echo ($extra ? "\n$extra" : '');
221 echo "\n</head>\n<body style=\"margin: {$margin}px;\"" . (($pageclass !== ':default:') ? " class=\"$pageclass\"" : '') . (($onload) ? " onload=\"$onload\"" : '') . ">\n";
222
223 if (!defined('HIDE_SETUP') AND function_exists('_printer_page_start'))
224 {
225 _printer_page_start();
226 }
227
228 echo "<div style=\"margin: {$pagemargin}px;\">\n<!-- / page head -->\n\n";
229
230 if (!defined('DONE_HEADER'))
231 {
232 define('DONE_HEADER', 1);
233 }
234 }
235
236 // ###################################################################
237 /**
238 * Links CSS to the page from a given relative path
239 *
240 * @access public
241 *
242 * @param string Relative path to the CSS file
243 */
244 function css_link($path)
245 {
246 $this->css .= "\n\t<link rel=\"stylesheet\" href=\"$path\" />";
247 }
248
249 // ###################################################################
250 /**
251 * Imbeds actual CSS information into the page in <style> tags
252 *
253 * @access public
254 *
255 * @param string Path of the CSS file to be imbeded
256 */
257 function css_imbed($path)
258 {
259 $data = require_once($path);
260 $css = preg_replace('#/\*(.*?)\*/(\r|\n)*#s', '', $css);
261 $css = trim($css);
262 $this->css .= "\n\t<style type=\"text/css\">\n\t<!--\n" . $css . "\n\t//-->\n\t</style>";
263 }
264
265 // ###################################################################
266 /**
267 * Places raw HTML code directly into the documet at the current
268 * position
269 *
270 * @access public
271 *
272 * @param string HTML code
273 */
274 function page_code($code)
275 {
276 echo "\n\n$code\n\n";
277 }
278
279 // ###################################################################
280 /**
281 * A block function that produces a table with a message in it. This
282 * does not print the header and footer.
283 *
284 * @access public
285 *
286 * @param string The title of the message (appears at the top of the block)
287 * @param string Content of the message
288 */
289 function page_message($title, $message)
290 {
291 $this->table_start(true, '75%');
292 $this->table_head($title, 1);
293 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
294 $this->table_end();
295 }
296
297 // ###################################################################
298 /**
299 * Produces an entire page layout that asks the user whether or not
300 * they want to perform X action and provides a link to the YES and NO
301 * action
302 *
303 * @access public
304 *
305 * @param string Message that asks if they want to do X
306 * @param string Location to go for YES
307 * @param string DO action to pass
308 * @param array Hidden parameters to pass to the next page
309 */
310 function page_confirm($message, $location, $action, $params)
311 {
312 $this->page_start($this->registry->modules['localize']->string('Confirm'));
313
314 $this->form_start($location, $action);
315 foreach ($params AS $key => $value)
316 {
317 $this->form_hidden_field($key, $value);
318 }
319
320 $this->table_start(true, '75%');
321 $this->table_head($this->registry->modules['localize']->string('Confirm'), 1);
322 $this->row_span("<blockquote>$message</blockquote>", ':swap:', 'left', 1);
323 $this->row_submit('<input type="button" class="button" name="no" value=" ' . $this->registry->modules['localize']->string('No') . ' " onclick="history.back(1); return false;" />', $this->registry->modules['localize']->string('Yes'), '');
324 $this->table_end();
325
326 $this->form_end();
327
328 $this->page_end();
329 }
330
331 // ###################################################################
332 /**
333 * Closes the HTML document structure an adds the copyright; this also
334 * stops execution of the page
335 *
336 * @access public
337 */
338 function page_end()
339 {
340 if ($this->registry->debug AND isset($_GET['query']))
341 {
342 ob_clean();
343 ob_end_clean();
344
345 if (is_array($this->registry->modules['db_mysql']->history))
346 {
347 echo '<pre>';
348 foreach ($this->registry->modules['db_mysql']->history AS $query)
349 {
350 echo $query . "\n\n<hr />\n\n";
351 }
352 echo '</pre>';
353 }
354 exit;
355 }
356
357 $copyright = "\n<br />\n<p align=\"center\" class=\"copyright\">\n\t<a href=\"http://www.iris-studios.com\" target=\"_blank\">" . $this->registry->application . ' ' . $this->registry->appversion . ", &copy; 2002 - " . date('Y') . " Iris Studios, Inc.</a>\n</p>";
358
359 if (!defined('HIDE_SETUP'))
360 {
361 echo "\n<!-- page end -->\n</div>\n$copyright";
362 }
363 else
364 {
365 echo "\n<!-- page end -->\n</div>";
366 }
367
368 echo $this->registry->construct_debug_block(false);
369
370 echo "\n\n</body>\n</html>";
371
372 exit;
373 }
374
375 // -------------------------------------------------------------------
376
377 // ###################################################################
378 /**
379 * Opens a <table> tag with styling
380 *
381 * @access public
382 *
383 * @param bool Whether to add a <br /> before the table
384 * @param string Value of the width attribute
385 */
386 function table_start($break = true, $width = '90%')
387 {
388 if ($break)
389 {
390 echo '<br />';
391 }
392
393 echo "\n<table cellpadding=\"4\" cellspacing=\"0\" border=\"0\" align=\"center\" width=\"$width\" class=\"tborder\">\n";
394 }
395
396 // ###################################################################
397 /**
398 * Adds a table row that is sued to head the entire table
399 *
400 * @access public
401 *
402 * @param string Title string
403 * @param integer Colspan attribute value
404 * @param bool Whether to bold the title
405 */
406 function table_head($title, $colspan = 2, $strong = true)
407 {
408 echo "<tr>\n\t<td class=\"tcat\" align=\"center\" colspan=\"$colspan\">" . (($strong) ? "<strong>$title</strong>" : $title) . "</td>\n</tr>\n";
409 }
410
411 // ###################################################################
412 /**
413 * Creates column headings; useful for a grid-style page. This uses a
414 * different styling than table_head() and is usually used directly
415 * after a table header.
416 *
417 * @access public
418 *
419 * @param array Array of titles to print
420 */
421 function table_column_head($columnarray)
422 {
423 if (is_array($columnarray))
424 {
425 $render = "<tr valign=\"top\" align=\"center\">\n";
426
427 foreach ($columnarray AS $header)
428 {
429 $render .= "\t<td class=\"thead\" align=\"center\">$header</td>\n";
430 }
431
432 $render .= "</tr>\n";
433
434 echo $render;
435 }
436 }
437
438 // ###################################################################
439 /**
440 * Closes a <table> tag
441 *
442 * @access public
443 */
444 function table_end()
445 {
446 echo "\n</table>\n";
447 }
448
449 // -------------------------------------------------------------------
450
451 // ###################################################################
452 /**
453 * Starts a <form> tag and adds the DO hidden input field
454 *
455 * @access public
456 *
457 * @param string Action/name of the file to action to
458 * @param string Value of the DO parameter; used to do-branch
459 * @param bool Enctype attribute; used for mime/multi-part
460 * @param string Name of the form; this only matters for DOM access
461 * @param string Method to action as; POST or GET (default is POST)
462 */
463 function form_start($action, $do, $enctype = false, $name = 'inputform', $submitmethod = 'post')
464 {
465 echo "\n<!-- input form -->\n<form name=\"$name\" action=\"$action\"" . (($enctype) ? " enctype=\"$enctype\"" : '') . " method=\"$submitmethod\">\n";
466
467 if ($do !== null)
468 {
469 $this->form_hidden_field('do', $do);
470 }
471 }
472
473 // ###################################################################
474 /**
475 * Adds a hidden field at the current location
476 *
477 * @access public
478 *
479 * @param string Name of the field
480 * @param string Value of the field
481 */
482 function form_hidden_field($name, $value)
483 {
484 echo "<input type=\"hidden\" name=\"$name\" value=\"$value\" />\n";
485 }
486
487 // ###################################################################
488 /**
489 * Closes a <form> tag
490 *
491 * @access public
492 */
493 function form_end()
494 {
495 echo "</form>\n<!-- / input form -->\n";
496 }
497
498 // -------------------------------------------------------------------
499
500 // ###################################################################
501 /**
502 * Creates a table row that spans an entire row; this is used to divide
503 * sections, usually
504 *
505 * @access public
506 *
507 * @param string Text to place in the row
508 * @param string Class name to style with; by default it alternates between alt1 and alt2 (use :swap: to do that)
509 * @param string Alignment of the text in the row
510 * @param integer Colspan attribute
511 */
512 function row_span($text, $class = ':swap:', $align = 'left', $colspan = 2)
513 {
514 if ($class === ':swap:')
515 {
516 $this->registry->modules['functions']->exec_swap_bg();
517 $row_class = $this->registry->modules['functions']->bgcolour;
518 $is_style_element = false;
519 }
520 else
521 {
522 if (preg_match('#:style:(.*?)#i', $class))
523 {
524 $is_style_element = true;
525 $style = str_replace(':style:', '', $class);
526 }
527 else
528 {
529 $row_class = $class;
530 $is_style_element = false;
531 }
532 }
533
534 echo "\n<tr>\n\t<td ". (($is_style_element) ? "style=\"$style\"" : "class=\"$row_class\"") . " colspan=\"$colspan\" align=\"$align\">$text</td>\n</tr>";
535 }
536
537 // ###################################################################
538 /**
539 * Creates a table row that has more than two columns; this is used in
540 * conjunction with table_column_head() usually; it takes an array of
541 * values
542 *
543 * @access public
544 *
545 * @param array Array of values in form value => alignment key (c for center, l for left, and r for right)
546 */
547 function row_multi_item($row_array)
548 {
549 $this->registry->modules['functions']->exec_swap_bg();
550
551 foreach ($row_array AS $item => $align)
552 {
553 $row_data["$align"][] = $item;
554 }
555
556 echo "<tr valign=\"top\">";
557
558 foreach ($row_data AS $align_key => $item_array)
559 {
560 if ($align_key == 'c')
561 {
562 $align = 'center';
563 }
564 else if ($align_key == 'l')
565 {
566 $align = 'left';
567 }
568 else if ($align_key == 'r')
569 {
570 $align = 'right';
571 }
572
573 foreach ($item_array AS $value)
574 {
575 echo "\n\t<td class=\"{$this->registry->modules['functions']->bgcolour}\" align=\"$align\">$value</td>";
576 }
577 }
578
579 echo "\n</tr>\n";
580 }
581
582 // ###################################################################
583 /**
584 * Generic row creation function that has two columns: label and value;
585 * this is used for many other form functions, but can also be used for
586 * non-editable fields
587 *
588 * @access public
589 *
590 * @param string Label text
591 * @param string HTML or text to place in the value column
592 * @param string Vertical align (valign attribute) for the row
593 * @param integer Colspan attribute
594 * @param string Class to style the row with; default is to alternate
595 */
596 function row_text($label, $value = '&nbsp;', $valign = 'top', $colspan = 2, $class = -1)
597 {
598 global $IS_SETTINGS;
599
600 if ($class == -1)
601 {
602 if (!$IS_SETTINGS)
603 {
604 $this->registry->modules['functions']->exec_swap_bg();
605 $row_class = $this->registry->modules['functions']->bgcolour;
606 }
607 else
608 {
609 $row_class = 'alt2';
610 }
611 }
612 else
613 {
614 $row_class = $class;
615 }
616
617 echo "<tr valign=\"$valign\">";
618 echo "\n\t<td class=\"$row_class\">$label</td>";
619 echo "\n\t<td class=\"$row_class\">$value</td>";
620
621 if ($colspan > 2)
622 {
623 echo "\n\t<td class=\"$row_class\" colspan=\"" . $colspan - 2 . "\">&nbsp;</td>";
624 }
625
626 echo "\n</tr>\n";
627 }
628
629 // ###################################################################
630 /**
631 * Creates a table row with an <input> text field as the value column
632 *
633 * @access public
634 *
635 * @param string Label text
636 * @param string Name of the <input> field
637 * @param string Value of the field
638 * @param integer Colspan attribute
639 * @param integer Size of the <input> field
640 * @param integer Length attribute; use FALSE for no length to be specified
641 * @param bool Whether to make this a password field
642 * @param string Vertical align (valign attribute)
643 */
644 function row_input($label, $name, $value = '', $colspan = 2, $size = 35, $length = false, $password = false, $lalign = 'top')
645 {
646 $this->row_text($label, "<input type=\"" . (($password) ? 'password' : 'text') . "\" class=\"input\" name=\"$name\" value=\"$value\" size=\"$size\" " . (($length) ? "maxlength=\"$length\" " : '') . "/>", $lalign, $colspan);
647 }
648
649 // ###################################################################
650 /**
651 * Creates a table row with a <textarea> as the value column
652 *
653 * @access public
654 *
655 * @param string Label text
656 * @param string Name of the <textarea>
657 * @param string Value of the <textarea>
658 * @param integer Colspan attribute
659 * @param integer Number of rows in the <textarea>
660 * @param integer Number of colums in the <textarea>
661 * @param bool Whether or not to use monospacing font
662 * @param string Extra style attributes to apply to the <textarea>
663 */
664 function row_textarea($label, $name, $value = '', $colspan = 2, $rows = 7, $cols = 50, $code = false, $style = '')
665 {
666 $this->row_text($label, "<textarea name=\"$name\" class=\"" . (($code) ? 'code' : 'input') . "\" rows=\"$rows\" cols=\"$cols\"" . (($style) ? ' style="' . $style . '"' : '') . ">$value</textarea>", 'top', $colspan);
667 }
668
669 // ###################################################################
670 /**
671 * Creates a table row with the tfoot class
672 *
673 * @access public
674 *
675 * @param string Extra text or HTML to insert into the row
676 * @param integer Colspan attribute
677 */
678 function row_tfoot($data, $colspan = 2)
679 {
680 echo $this->row_span($data, 'tfoot', 'center', $colspan);
681 }
682
683 // ###################################################################
684 /**
685 * Creates a tfoot table row with submit buttons
686 *
687 * @access public
688 *
689 * @param string Extra HTML to imbed in the row after the buttons
690 * @param string Submit button text (by default it uses pre-translated "Submit" from :save:)
691 * @param string Reset button text (default it uses pre-translated "Reset" from :reset:)
692 * @param integer Colspan attribute
693 */
694 function row_submit($extra = false, $submit = ':save:', $reset = ':reset:', $colspan = 2)
695 {
696 if ($submit === ':save:')
697 {
698 $submit = " " . $this->registry->modules['localize']->string('Submit') . " ";
699 }
700 else
701 {
702 $submit = " $submit ";
703 }
704
705 if ($reset === ':reset:')
706 {
707 $reset = " " . $this->registry->modules['localize']->string('Reset') . " ";
708 }
709 else
710 {
711 $reset = (($reset) ? " $reset " : '');
712 }
713
714 $output = "\n\t\t<input type=\"submit\" class=\"button\" name=\"__submit__\" value=\"$submit\" accesskey=\"s\" />";
715 $output .= ($reset ? "\n\t\t<input type=\"reset\" class=\"button\" name=\"__reset__\" value=\"$reset\" accesskey=\"r\" />" : '');
716 $output .= ($extra ? "\n\t\t$extra" : '');
717 $output .= "\n\t";
718 $this->row_tfoot($output, $colspan);
719 }
720
721 // ###################################################################
722 /**
723 * Creates an upload row; you need to specify some other paramaters in
724 * form_start() for this to work
725 *
726 * @access public
727 *
728 * @param string Label text
729 * @param string Upload name
730 * @param integer Colspan attribute
731 */
732 function row_upload($label, $name, $colspan = 2)
733 {
734 $this->row_text($label, "<input type=\"file\" class=\"button\" name=\"$name\" size=\"35\" />", 'top', $colspan);
735 }
736
737 // ###################################################################
738 /**
739 * Adds a name-value pair to an array that is constructed into a
740 * <select> list
741 *
742 * @access public
743 *
744 * @param string Text displayed for the option
745 * @param string Value of the option
746 * @param bool Whether or not to select this particluar option
747 */
748 function list_item($name, $value, $selected = false)
749 {
750 global $listitem;
751
752 $listitem[] = "\n\t<option value=\"$value\"" . (($selected == true) ? ' selected="selected"' : '') . ">$name</option>";
753 }
754
755 // ###################################################################
756 /**
757 * Assembles a <select> table row from list_item() items
758 *
759 * @access public
760 *
761 * @param string Label text
762 * @param string Name of the <select>
763 * @param bool Automatically submit the form on a change?
764 * @param integer Colspan attribute
765 */
766 function row_list($label, $name, $is_jump = false, $colspan = 2)
767 {
768 global $listitem;
769
770 foreach ($listitem AS $option)
771 {
772 $optionlist .= $option;
773 }
774
775 $listitem = '';
776
777 $this->row_text($label, "\n<select class=\"button\" name=\"$name\"" . (($is_jump) ? " onchange=\"this.form.submit();\"" : '') . ">$optionlist\n</select>" . (($is_jump) ? "\n<input type=\"submit\" class=\"button\" value=\" " . $this->registry->modules['localize']->string('Go') . " \" accesskey=\"g\" />" : '') . "\n", $colspan);
778 }
779
780 // ###################################################################
781 /**
782 * Creates a row with two radio buttons: yes and now
783 *
784 * @access public
785 *
786 * @param string Label text
787 * @param string Name of the BOOL flag
788 * @param bool TRUE to select the YES by default; FALSE for NO
789 * @param integer Colspan attribute
790 */
791 function row_yesno($label, $name, $value, $colspan = 2)
792 {
793 $this->row_text($label, "<input type=\"radio\" name=\"$name\" value=\"1\"" . (($value) ? ' checked="checked"' : '') . " /> " . $this->registry->modules['localize']->string('Yes') . " <input type=\"radio\" name=\"$name\" value=\"0\"" . ((!$value) ? ' checked="checked"' : '') . " /> " . $this->registry->modules['localize']->string('No'), $colspan);
794 }
795 }
796
797 /*=====================================================================*\
798 || ###################################################################
799 || # $HeadURL$
800 || # $Id$
801 || ###################################################################
802 \*=====================================================================*/
803 ?>