aboutsummaryrefslogtreecommitdiff
path: root/mod/sitepages/start.php
blob: 2960bd6a53af3fe2e87a2ebe9bf05cd9dc02be3c (plain)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?php
/**
 * Site Pages provides interfaces to create standard content-static pages
 * and to customize the front page layout and content.
 *
 * Formerly implemented as "external pages" and "custom index."
 *
 * @package SitePages
 *
 * @todo
 * 	Make sure this stuff doesn't show up in search.
 * 	DRY up actions and views
 * 	Use $entity->view to redirect to url of page.
 * 	The tool settings view is probably not needed as it can be added to the front page edit tab.
 * 	You can say pg/sitepages/read/any_page_i_want and it will let you.
 */

/**
 * Start the site pages plugin.
 */
function sitepages_init() {
	require_once(dirname(__FILE__) . '/sitepages_functions.php');
	global $CONFIG;

	// Extend CSS
	elgg_extend_view('css', 'sitepages/css');

	// register our subtype
	run_function_once('sitepages_runonce');

	// Register a page handler, so we can have nice URLs
	register_page_handler('sitepages', 'sitepages_page_handler');

	// Register a URL handler for external pages
	register_entity_url_handler('sitepages_url', 'object', 'sitepages');

	elgg_extend_view('footer/links', 'sitepages/footer_menu');
	elgg_extend_view('html_head/extend', 'sitepages/metatags');

	// Replace the default index page if user has requested and the site is not running walled garden
	if (get_plugin_setting('ownfrontpage', 'sitepages') == 'yes') {
		elgg_register_plugin_hook_handler('index', 'system', 'sitepages_custom_index');
	}

	// define our own ecml keywords and views
	elgg_register_plugin_hook_handler('get_keywords', 'ecml', 'sitepages_ecml_keyword_hook');
	elgg_register_plugin_hook_handler('get_views', 'ecml', 'sitepages_ecml_views_hook');

	// hook into the walled garden pages
	elgg_register_plugin_hook_handler('public_pages', 'walled_garden', 'sitepages_public_pages');

	register_action('settings/sitepages/save', FALSE, "{$CONFIG->pluginspath}sitepages/actions/edit_settings.php");
	
}

/**
 * Registers the sitepages subtype to the right class.
 *
 * @return bool
 */
function sitepages_runonce() {
	return add_subtype('object', 'sitepages_page', 'ElggSitePage');
}

/**
 * Override the index if requested.
 *
 * @return TRUE on override
 */
function sitepages_custom_index() {
	// context is checked by the extended metatags view to print out its custom CSS
	//$context = elgg_get_context();
	//elgg_set_context('sitepages:front');

	//if ($contents = elgg_view('sitepages/custom_frontpage')) {
	//	echo elgg_view_page(FALSE, $contents);

	//	elgg_set_context($context);
		// return TRUE to tell index.php we've got its content right here.
	//	return TRUE;
	//}

	//elgg_set_context($context);

	// return NULL to pass this to next in chain, or back to standard index.php.
	//return NULL;
	if (!include_once(dirname(dirname(__FILE__))) . "/sitepages/index.php") {
		return false;
	}
	return true;
}

/**
 *
 * @param unknown_type $expage
 * @return unknown_type
 *
 * //@todo is this needed?
 */
function sitepages_url($expage) {
	global $CONFIG;
	return 'pg/sitepages/';
}

/**
 * Serve out views for site pages.
 *
 * @param unknown_type $page
 * @return unknown_type
 */
function sitepages_page_handler($page) {
	global $CONFIG;

	// for the owner block.
	if ($logged_in_guid = get_loggedin_userid()) {
		set_page_owner($logged_in_guid);
	}

	// sanity checking.
	// on bad params we'll forward so people will bookmark the correct URLs
	// @todo valid page names need to be pulled out into some sort of config var or admin option.
	$default_page = 'About';

	$action = isset($page[0]) ? $page[0] : FALSE;
	$page_type = isset($page[1]) ? $page[1] : FALSE;

	switch ($action) {
		case 'read':
			$title = elgg_echo('sitepages:' . strtolower($page_type));
			$content = sitepages_get_page_content($page_type);

			break;

		default:
			forward("{$CONFIG->site->url}pg/sitepages/read/$default_page");
			break;
	}

	echo elgg_view_page($title, $content);
}


/**
 * Register some default keywords.
 *
 * @param unknown_type $hook
 * @param unknown_type $entity_type
 * @param unknown_type $return_value
 * @param unknown_type $params
 * @return unknown_type
 */
function sitepages_ecml_keyword_hook($hook, $entity_type, $return_value, $params) {
	$return_value['loginbox'] = array(
		'view' => 'account/login_box',
		'description' => elgg_echo('sitepages:ecml:keywords:loginbox:desc'),
		'usage' => elgg_echo('sitepages:ecml:keywords:loginbox:usage'),
		'restricted' => array('sitepages/custom_frontpage')
	);

	$return_value['userlist'] = array(
		'view' => 'sitepages/keywords/userlist',
		'description' => elgg_echo('sitepages:ecml:keywords:userlist:desc'),
		'usage' => elgg_echo('sitepages:ecml:keywords:userlist:usage'),
		'restricted' => array('sitepages/custom_frontpage')
	);

//	$return_value['sitestats'] = array(
//		'view' => 'sitepages/keywords/sitestats',
//		'description' => elgg_echo('sitepages:ecml:keywords:sitestats:desc'),
//		'usage' => elgg_echo('sitepages:ecml:keywords:sitestats:usage'),
//		'restricted' => array('sitepages/custom_frontpage')
//	);

	$return_value['entities'] = array(
		'description' => elgg_echo('sitepages:ecml:keywords:entity:desc'),
		'usage' => elgg_echo('sitepages:ecml:keywords:entity:usage'),
		'restricted' => array('sitepages/custom_frontpage')
	);

	$return_value['view'] = array(
		'description' => elgg_echo('sitepages:ecml:keywords:view:desc'),
		'usage' => elgg_echo('sitepages:ecml:keywords:view:usage'),
		'restricted' => array('sitepages/custom_frontpage')
	);

	return $return_value;
}

/**
 * Register the frontpage with ECML.
 *
 * @param unknown_type $hook
 * @param unknown_type $entity_type
 * @param unknown_type $return_value
 * @param unknown_type $params
 */
function sitepages_ecml_views_hook($hook, $entity_type, $return_value, $params) {
	$return_value['sitepages/custom_frontpage'] = elgg_echo('sitepages:ecml:views:custom_frontpage');

	return $return_value;
}

function sitepages_public_pages($hook, $type, $return_value, $params) {
	$return_value[] = 'pg/sitepages/read/About';
	$return_value[] = 'pg/sitepages/read/Terms';
	$return_value[] = 'pg/sitepages/read/Privacy';

	return $return_value;
}

elgg_register_event_handler('init', 'system', 'sitepages_init');