content.systempreferences.php

<?php

	/**
	 * @package content
	 */

	/**
	 * The Preferences page allows Developers to change settings for
	 * this Symphony install. Extensions can extend the form on this
	 * page so they can have their own settings. This page is typically
	 * a UI for a subset of the `CONFIG` file.
	 */
	require_once(TOOLKIT . '/class.administrationpage.php');

	class contentSystemPreferences extends AdministrationPage {

		public $_errors = array();

		// Overload the parent 'view' function since we dont need the switchboard logic
		public function view() {
			$this->setPageType('form');
			$this->setTitle(__('%1$s &ndash; %2$s', array(__('Preferences'), __('Symphony'))));

			$this->appendSubheading(__('Preferences'));

			$bIsWritable = true;
			$formHasErrors = (is_array($this->_errors) && !empty($this->_errors));

			if (!is_writable(CONFIG)) {
				$this->pageAlert(__('The Symphony configuration file, %s, is not writable. You will not be able to save changes to preferences.', array('<code>/manifest/config.php</code>')), Alert::ERROR);
				$bIsWritable = false;
			}
			else if ($formHasErrors) {
				$this->pageAlert(
					__('An error occurred while processing this form. See below for details.')
					, Alert::ERROR
				);
			}
			else if (isset($this->_context[0]) && $this->_context[0] == 'success') {
				$this->pageAlert(__('Preferences saved.'), Alert::SUCCESS);
			}

			// Get available languages
			$languages = Lang::getAvailableLanguages();

			if(count($languages) > 1) {
				// Create language selection
				$group = new XMLElement('fieldset');
				$group->setAttribute('class', 'settings');
				$group->appendChild(new XMLElement('legend', __('System Language')));
				$label = Widget::Label();

				// Get language names
				asort($languages);

				foreach($languages as $code => $name) {
					$options[] = array($code, $code == Symphony::Configuration()->get('lang', 'symphony'), $name);
				}
				$select = Widget::Select('settings[symphony][lang]', $options);
				$label->appendChild($select);
				$group->appendChild($label);
				$group->appendChild(new XMLElement('p', __('Authors can set up a differing language in their profiles.'), array('class' => 'help')));
				// Append language selection
				$this->Form->appendChild($group);
			}

			// Get available EmailGateways
			$email_gateway_manager = new EmailGatewayManager;
			$email_gateways = $email_gateway_manager->listAll();
			if(count($email_gateways) >= 1){
				$group = new XMLElement('fieldset', NULL, array('class' => 'settings condensed'));
				$group->appendChild(new XMLElement('legend', __('Default Email Settings')));
				$label = Widget::Label(__('Gateway'));

				// Get gateway names
				ksort($email_gateways);

				$default_gateway = $email_gateway_manager->getDefaultGateway();
				$selected_is_installed = $email_gateway_manager->__getClassPath($default_gateway);

				$options = array();
				foreach($email_gateways as $handle => $details) {
					$options[] = array($handle, (($handle == $default_gateway) || (($selected_is_installed == false) && $handle == 'sendmail')), $details['name']);
				}
				$select = Widget::Select('settings[Email][default_gateway]', $options, array('class' => 'picker'));
				$label->appendChild($select);
				$group->appendChild($label);
				// Append email gateway selection
				$this->Form->appendChild($group);
			}

			foreach($email_gateways as $gateway){
				$gateway_settings = $email_gateway_manager->create($gateway['handle'])->getPreferencesPane();

				if(is_a($gateway_settings, 'XMLElement')){
					$this->Form->appendChild($gateway_settings);
				}
			}

			/**
			 * Add Extension custom preferences. Use the $wrapper reference to append objects.
			 *
			 * @delegate AddCustomPreferenceFieldsets
			 * @param string $context
			 * '/system/preferences/'
			 * @param XMLElement $wrapper
			 *  An XMLElement of the current page
			 * @param array $errors
			 *  An array of errors
			 */
			Symphony::ExtensionManager()->notifyMembers('AddCustomPreferenceFieldsets', '/system/preferences/', array(
				'wrapper' => &$this->Form,
				'errors' => $this->_errors
			));

			$div = new XMLElement('div');
			$div->setAttribute('class', 'actions');

			$attr = array('accesskey' => 's');
			if(!$bIsWritable) $attr['disabled'] = 'disabled';
			$div->appendChild(Widget::Input('action[save]', __('Save Changes'), 'submit', $attr));

			$this->Form->appendChild($div);
		}

		public function action() {
			// Do not proceed if the config file is read only
			if (!is_writable(CONFIG)) redirect(SYMPHONY_URL . '/system/preferences/');

			/**
			 * Extensions can listen for any custom actions that were added
			 * through `AddCustomPreferenceFieldsets` or `AddCustomActions`
			 * delegates.
			 *
			 * @delegate CustomActions
			 * @param string $context
			 * '/system/preferences/'
			 */
			Symphony::ExtensionManager()->notifyMembers('CustomActions', '/system/preferences/');

			if (isset($_POST['action']['save'])) {
				$settings = $_POST['settings'];

				/**
				 * Just prior to saving the preferences and writing them to the `CONFIG`
				 * Allows extensions to preform custom validation logic on the settings.
				 *
				 * @delegate Save
				 * @param string $context
				 * '/system/preferences/'
				 * @param array $settings
				 *  An array of the preferences to be saved, passed by reference
				 * @param array $errors
				 *  An array of errors passed by reference
				 */
				Symphony::ExtensionManager()->notifyMembers('Save', '/system/preferences/', array('settings' => &$settings, 'errors' => &$this->_errors));

				if (!is_array($this->_errors) || empty($this->_errors)) {

					if(is_array($settings) && !empty($settings)) {
						Symphony::Configuration()->setArray($settings, false);
					}

					Symphony::Configuration()->write();

					redirect(SYMPHONY_URL . '/system/preferences/success/');
				}
			}
		}
	}