aboutsummaryrefslogtreecommitdiffstats
path: root/Zotlabs/Module/Help.php
blob: 241354d0701072dcbb9c9373d82a5a5d04ead1c9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?php
namespace Zotlabs\Module;


require_once('include/help.php');

/**
 * You can create local site resources in doc/Site.md and either link to doc/Home.md for the standard resources
 * or use our include mechanism to include it on your local page.
 *
 * #include doc/Home.md;
 *
 * The syntax is somewhat strict. 
 *
 */

class Help extends \Zotlabs\Web\Controller {

	function get() {
		nav_set_selected('help');
	
		if($_REQUEST['search']) {
		
			$o .= '<div id="help-content" class="generic-content-wrapper">';
			$o .= '<div class="section-title-wrapper">';
			$o .= '<h2>' . t('Documentation Search') . ' - ' . htmlspecialchars($_REQUEST['search']) . '</h2>';
			$o .= '</div>';
			$o .= '<div class="section-content-wrapper">';
	
			$r = search_doc_files($_REQUEST['search']);
			if($r) {
				$o .= '<ul class="help-searchlist">';
				foreach($r as $rr) {
					$dirname = dirname($rr['v']);
					$fname = basename($rr['v']);
					$fname = substr($fname,0,strrpos($fname,'.'));
					$path = trim(substr($dirname,4),'/');
	
					$o .= '<li><a href="help/' . (($path) ? $path . '/' : '') . $fname . '" >' . ucwords(str_replace('_',' ',notags($fname))) . '</a><br />'
						. '<b><i>' . 'help/' . (($path) ? $path . '/' : '') . $fname . '</i></b><br />' .
					'...' . str_replace('$Projectname',\Zotlabs\Lib\System::get_platform_name(),$rr['text']) . '...<br /><br /></li>';
	
				}
				$o .= '</ul>';
				$o .= '</div>';
				$o .= '</div>';
			}
			return $o;
		}
	
	
		global $lang;
	
		$doctype = 'markdown';
	
		$text = '';
	
		if(argc() > 1) {
			$path = '';
			for($x = 1; $x < argc(); $x ++) {
				if(strlen($path))
					$path .= '/';
				$path .= argv($x);
			}
			$title = basename($path);
	
			$text = load_doc_file('doc/' . $path . '.md');
			\App::$page['title'] = t('Help:') . ' ' . ucwords(str_replace('-',' ',notags($title)));
	
			if(! $text) {
				$text = load_doc_file('doc/' . $path . '.bb');
				if($text)
					$doctype = 'bbcode';
				\App::$page['title'] = t('Help:') . ' ' . ucwords(str_replace('_',' ',notags($title)));
			}
			if(! $text) {
				$text = load_doc_file('doc/' . $path . '.html');
				if($text)
					$doctype = 'html';
				\App::$page['title'] = t('Help:') . ' ' . ucwords(str_replace('-',' ',notags($title)));
			}
		}
	
		if(! $text) {
			$text = load_doc_file('doc/Site.md');
			\App::$page['title'] = t('Help');
		}
		if(! $text) {
			$doctype = 'bbcode';
			$text = load_doc_file('doc/main.bb');
			\App::$page['title'] = t('Help');
		}
		
		if(! strlen($text)) {
			header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . t('Not Found'));
			$tpl = get_markup_template("404.tpl");
			return replace_macros($tpl, array(
				'$message' =>  t('Page not found.' )
			));
		}
	
		if($doctype === 'html')
			$content = $text;
		if($doctype === 'markdown')	{
			require_once('library/markdown.php');
			# escape #include tags
			$text = preg_replace('/#include/ism', '%%include', $text);
			$content = Markdown($text);
			$content = preg_replace('/%%include/ism', '#include', $content);
		}
		if($doctype === 'bbcode') {
			require_once('include/bbcode.php');
			$content = bbcode($text);
			// bbcode retargets external content to new windows. This content is internal.
			$content = str_replace(' target="_blank"','',$content);		
		} 
	
		$content = preg_replace_callback("/#include (.*?)\;/ism", 'self::preg_callback_help_include', $content);
	
		return replace_macros(get_markup_template("help.tpl"), array(
			'$title' => t('$Projectname Documentation'),
			'$content' => translate_projectname($content)
		));
	
	}
	
	
	private static function preg_callback_help_include($matches) {
	
		if($matches[1]) {
			$include = str_replace($matches[0],load_doc_file($matches[1]),$matches[0]);
			if(preg_match('/\.bb$/', $matches[1]) || preg_match('/\.txt$/', $matches[1])) {
				require_once('include/bbcode.php');
				$include = bbcode($include);
				$include = str_replace(' target="_blank"','',$include);		
			} 
			elseif(preg_match('/\.md$/', $matches[1])) {
				require_once('library/markdown.php');
				$include = Markdown($include);
			}
			return $include;
		}
	
	}
	
	
}