qa-widget-anywhere.php

<?php
/*
	Question2Answer Widget Anywhere plugin
	License: http://www.gnu.org/licenses/gpl.html
*/

class qa_widget_anywhere
{
	private $directory;
	private $urltoroot;
	private $anchor;
	private $pluginkey = 'widgetanyw';
	private $opt = 'widgetanyw_active';

	// NOTE: most of the old positions have been removed in favour of the standard Q2A positions
	private $positionlangs = array(
		'head-tag' => 'Inside &lt;HEAD&gt; tag',
		'q-item-after' => 'After question text',

		'full-top'    => 'options/place_full_top',
		'full-high'   => 'options/place_full_below_nav',
		'full-low'    => 'options/place_full_below_content',
		'full-bottom' => 'options/place_full_below_footer',

		'main-top'    => 'options/place_main_top',
		'main-high'   => 'options/place_main_below_title',
		'main-low'    => 'options/place_main_below_lists',
		'main-bottom' => 'options/place_main_bottom',

		'side-top'    => 'options/place_side_top',
		'side-high'   => 'options/place_side_below_sidebar',
		'side-low'    => 'options/place_side_below_categories',
		'side-bottom' => 'options/place_side_last',
	);


	// copied from qa-page-admin-widgets.php
	private $templatelangkeys = array(
		'question' => 'admin/question_pages',
		'qa' => 'main/recent_qs_as_title',
		'activity' => 'main/recent_activity_title',
		'questions' => 'admin/question_lists',
		'hot' => 'main/hot_qs_title',
		'unanswered' => 'main/unanswered_qs_title',
		'tags' => 'main/popular_tags',
		'categories' => 'misc/browse_categories',
		'users' => 'main/highest_users',
		'ask' => 'question/ask_title',
		'tag' => 'admin/tag_pages',
		'user' => 'admin/user_pages',
		'message' => 'misc/private_message_title',
		'search' => 'main/search_title',
		'feedback' => 'misc/feedback_title',
		'login' => 'users/login_title',
		'register' => 'users/register_title',
		'account' => 'profile/my_account_title',
		'favorites' => 'misc/my_favorites_title',
		'updates' => 'misc/recent_updates_title',
		'ip' => 'admin/ip_address_pages',
		'admin' => 'admin/admin_title',
	);

	public function load_module( $directory, $urltoroot )
	{
		$this->directory = $directory;
		$this->urltoroot = $urltoroot;
		$this->anchor = md5('page/Widget Anywhere');

		// set up position list
		foreach ( $this->positionlangs as $pos=>$langkey )
			$this->positionlangs[$pos] = strpos($langkey, 'options/') === 0 ? qa_lang_html($langkey) : $langkey;

	}

	function match_request( $request )
	{
		return $request == 'admin/'.$this->pluginkey;
	}

	function init_queries( $tableslc )
	{
		$tablename = qa_db_add_table_prefix($this->pluginkey);

		if ( !in_array($tablename, $tableslc) )
		{
			return 'CREATE TABLE IF NOT EXISTS ^'.$this->pluginkey.' ( '.
				'`id` smallint(5) unsigned NOT NULL AUTO_INCREMENT, '.
				'`title` varchar(30) NOT NULL, '.
				'`pages` varchar(800) NOT NULL, '.
				'`position` varchar(30) NOT NULL, '.
				'`ordering` smallint(5) unsigned NOT NULL, '.
				'`content` text NOT NULL, '.
				'PRIMARY KEY (`id`), '.
				'KEY `position` (`position`,`ordering`) '.
			' ) ENGINE=InnoDB DEFAULT CHARSET=utf8';
		}

		// we're already set up
		qa_opt( $this->opt, '1' );
		return null;
	}

	function process_request( $request )
	{
		// double check we are admin
		if ( qa_get_logged_in_level() < QA_USER_LEVEL_ADMIN )
			return;

		if ( qa_clicked('docancel') )
			qa_redirect('admin/plugins');

		$qa_content = qa_content_prepare();
		$qa_content['title'] = 'Widget Anywhere';
		$qa_content['custom'] = '<p><a href="' . qa_path('admin/plugins').'#'.qa_html($this->anchor) . '">&laquo; back to plugin options</a></p>';

		$saved_msg = null;
		$editid = qa_get('editid');

		if ( qa_post_text('dodelete') )
		{
			$this->delete_widget();
			qa_redirect( 'admin/plugins' );
		}
		else if ( qa_clicked('save_button') )
		{
			// save widget
			$widget = $this->save_widget();
			$saved_msg = 'Widget saved.';
		}
		else if ( empty($editid) )
		{
			// display blank form
			$widget = array(
				'id' => 0,
				'title' => '',
				'pages' => '',
				'position' => '',
				'ordering' => 1,
				'content' => '',
			);
		}
		else
		{
			// load specified widget
			$sql = 'SELECT * FROM ^'.$this->pluginkey.' WHERE id=#';
			$result = qa_db_query_sub($sql, $editid);
			$widget = qa_db_read_one_assoc($result);
		}

		$sel_position = empty($widget['position']) ? null : @$this->positionlangs[$widget['position']];

		// set up page (template) list
		$widget_pages = explode( ',', $widget['pages'] );

		$sel_pages = array();
		$custom_pages = array();
		foreach ( $widget_pages as $page )
		{
			if ( strpos($page, 'custom:') === 0 )
				$custom_pages[] = substr($page, 7);
			else
				$sel_pages[] = $page;
		}

		// $chkd = in_array('all', $sel_pages) ? 'checked' : '';
		// $pages_html = '<label><input type="checkbox" name="wpages_all" ' . $chkd . '> ' . qa_lang_html('admin/widget_all_pages') . '</label><br><br>';

		$pages_html = '';
		foreach ( $this->templatelangkeys as $tmpl=>$langkey )
		{
			$chkd = in_array($tmpl, $sel_pages) ? 'checked' : '';
			$pages_html .= '<label><input type="checkbox" name="wpages_' . $tmpl . '" ' . $chkd . '> ' . qa_lang_html($langkey) . '</label><br>';
		}

		$qa_content['form'] = array(
			'tags' => 'METHOD="POST" ACTION="'.qa_self_html().'"',
			'style' => 'tall',
			'ok' => $saved_msg,

			'fields' => array(
				'title' => array(
					'label' => 'Title',
					'tags' => 'NAME="wtitle"',
					'value' => qa_html($widget['title']),
				),

				'position' => array(
					'type' => 'select',
					'label' => 'Position',
					'tags' => 'NAME="wposition"',
					'options' => $this->positionlangs,
					'value' => $sel_position,
				),

				'all_pages' => array(
					'type' => 'checkbox',
					'id' => 'tb_pages_all',
					'label' => qa_lang_html('admin/widget_all_pages'),
					'tags' => 'NAME="wpages_all" ID="wpages_all"',
					'value' => in_array('all', $sel_pages),
				),

				'pages' => array(
					'type' => 'custom',
					'id' => 'tb_pages_list',
					'label' => qa_lang_html('admin/widget_pages_explanation'),
					'html' => $pages_html,
				),

				'show_custom_pages' => array(
					'type' => 'checkbox',
					'id' => 'tb_show_custom_pages',
					'label' => 'Show on custom page(s)',
					'tags' => 'NAME="cb_custom_pages" ID="cb_custom_pages"',
					'value' => count($custom_pages) > 0,
				),
				'custom_pages' => array(
					'id' => 'tb_custom_pages',
					'label' => 'Page slugs',
					'tags' => 'NAME="wpages_custom"',
					'value' => qa_html( implode(',', $custom_pages) ),
					'note' => 'Separate multiple page slugs (URL fragments) with commas, e.g. <code>custom-page,other-page</code>',
				),

				'ordering' => array(
					'type' => 'number',
					'label' => 'Order',
					'tags' => 'NAME="wordering"',
					'value' => qa_html($widget['ordering']),
				),

				'content' => array(
					'type' => 'textarea',
					'label' => 'Content (HTML)',
					'tags' => 'NAME="wcontent"',
					'value' => qa_html($widget['content']),
					'rows' => 12,
				),
			),

			'hidden' => array(
				'wid' => $widget['id'],
			),

			'buttons' => array(
				'save' => array(
					'tags' => 'NAME="save_button"',
					'label' => 'Save widget',
					'value' => '1',
				),

				'cancel' => array(
					'tags' => 'NAME="docancel"',
					'label' => qa_lang_html('main/cancel_button'),
				),
			),
		);

		if ( $widget['id'] > 0 )
		{
			$qa_content['form']['fields']['delete'] = array(
				'tags' => 'NAME="dodelete"',
				'label' => 'Delete widget',
				'value' => 0,
				'type' => 'checkbox',
			);
		}

		qa_set_display_rules($qa_content, array(
			'tb_pages_list' => '!wpages_all',
			'tb_show_custom_pages' => '!wpages_all',
			'tb_custom_pages' => 'cb_custom_pages && !wpages_all',
		));

		return $qa_content;
	}

	function admin_form( &$qa_content )
	{
		$saved_msg = null;

		// link to set up plugin
		if ( qa_opt($this->opt) !== '1' )
		{
			return array(
				'fields' => array(
					array(
						'type' => 'custom',
						'error' => 'Widget Anywhere is not set up yet. <a href="' . qa_path('install') . '">Run setup</a>',
					),
				),
			);
		}


		// plugin is active, so show list of current widgets
		$sql = 'SELECT id, title, pages, position FROM ^'.$this->pluginkey.' ORDER BY position, ordering';
		$result = qa_db_query_sub($sql);
		$widgets = qa_db_read_all_assoc($result);

		$urlbase = 'admin/' . $this->pluginkey;
		$custom = '<ul>'."\n";
		foreach ( $widgets as $w )
		{
			$param = array( 'editid' => $w['id'] );
			$p = $w['position'];
			$posit = isset($this->positionlangs[$p]) ? $this->positionlangs[$p] : '[none]';
			$custom .= '<li>';
			$custom .= '<b>' . $w['title'] . '</b>';
			$custom .= ' - <a href="' . qa_path($urlbase, $param) . '">' . $posit . '</a>';
			$custom .= '</li>'."\n";
		}
		$custom .= '</ul>'."\n";
		$custom .= '<p><a href="' . qa_path($urlbase) . '">Add new widget</a></p>'."\n";


		return array(
			'ok' => $saved_msg,

			'fields' => array(
				array(
					'type' => 'custom',
					'html' => $custom,
				),
			),
		);
	}


	private function save_widget()
	{
		$widget = array();
		$widget['id'] = qa_post_text('wid');
		$widget['title'] = qa_post_text('wtitle');
		$widget['position'] = qa_post_text('wposition');
		$widget['ordering'] = qa_post_text('wordering');
		$widget['content'] = qa_post_text('wcontent');

		$pages = array();
		if ( qa_post_text('wpages_all') )
			$pages[] = 'all';
		else
		{
			foreach ( $this->templatelangkeys as $key=>$lang )
			{
				if ( qa_post_text('wpages_'.$key) )
					$pages[] = $key;
			}

			if ( qa_post_text('cb_custom_pages') )
			{
				$wpages_custom = explode( ',', qa_post_text('wpages_custom') );
				foreach ( $wpages_custom as $cp )
				{
					$pages[] = 'custom:'.$cp;
				}
			}
		}
		$widget['pages'] = implode( ',', $pages );

		if ( $widget['id'] === '0' )
		{
			$sql = 'INSERT INTO ^'.$this->pluginkey.' (id, title, pages, position, ordering, content) VALUES (0, $, $, $, #, $)';
			$success = qa_db_query_sub( $sql, $widget['title'], $widget['pages'], $widget['position'], $widget['ordering'], $widget['content'] );
			$widget['id'] = qa_db_last_insert_id();
		}
		else
		{
			$sql = 'UPDATE ^'.$this->pluginkey.' SET title=$, pages=$, position=$, ordering=#, content=$ WHERE id=#';
			$success = qa_db_query_sub( $sql, $widget['title'], $widget['pages'], $widget['position'], $widget['ordering'], $widget['content'], $widget['id'] );
		}

		return $widget;
	}

	private function delete_widget()
	{
		$wid = qa_post_text('wid');
		$sql = 'DELETE FROM ^'.$this->pluginkey.' WHERE id=#';
		return qa_db_query_sub( $sql, $wid );
	}

}