ext.tag_sync.php | searchcode

/extensions/ext.tag_sync.php

https://github.com/amphibian/ext.tag_sync.ee_addon
PHP | 425 lines | 297 code | 78 blank | 50 comment | 27 complexity | db525ff62d036fc1586c9c48b4a1bc6b MD5 | raw file

<?php

if(!defined('EXT'))
{
	exit('Invalid file request');
}

class Tag_sync
{
	var $settings        = array();
	var $name            = 'Tag Synchronizer';
	var $version         = '1.0.5';
	var $description     = 'Synchronize Solspace Tag tags to a custom field when entries are publish or updated, or all at once.';
	var $settings_exist  = 'y';
	var $docs_url        = 'http://github.com/amphibian/ext.tag_sync.ee_addon';
	var $batch_size		 = 1000;

	
	// -------------------------------
	//   Constructor - Extensions use this for settings
	// -------------------------------
	
	function Tag_sync($settings='')
	{
	    $this->settings = $settings;
	}
	// END
	
	
	// --------------------------------
	//  Settings
	// --------------------------------  
	
	function settings_form($current)
	{
		global $DB, $DSP, $IN, $LANG, $PREFS;
		
		// Synchronize all tags to a specific weblog's custom field
		if(isset($_GET['sync_weblog']) && !empty($current['weblog_id_'.$_GET['sync_weblog']]))
		{
			$sync_weblog = $_GET['sync_weblog'];
			$custom_field = $current['weblog_id_'.$sync_weblog];
			$current_batch = (isset($_GET['batch'])) ? $_GET['batch'] : 1;
			
			// Get count of entry IDs in this weblog which have tags
			$sql = "SELECT COUNT(DISTINCT entry_id) as count FROM exp_tag_entries WHERE weblog_id = ".$DB->escape_str($sync_weblog);
			$count = $DB->query($sql);
			
			if($count->row['count'] > 0)
			{
				$batches = ceil($count->row['count'] / $this->batch_size);
				$offset = ($current_batch - 1) * $this->batch_size;
				
				// Get the current batch of tagged entries to sync
				$sql = "SELECT DISTINCT entry_id FROM exp_tag_entries 
						WHERE weblog_id = ".$DB->escape_str($sync_weblog)." 
						ORDER BY entry_id ASC LIMIT $offset, ".$this->batch_size;
						
				$entries = $DB->query($sql);
				$entry_ids = array();
				foreach($entries->result as $result)
				{	
					$entry_ids[] = $result['entry_id'];
				}
				
				// Get all tags for this batch's entry_ids
				$sql = "SELECT DISTINCT t.tag_name, e.entry_id FROM exp_tag_entries AS e
						LEFT JOIN exp_tag_tags AS t ON e.tag_id = t.tag_id 
						WHERE e.entry_id IN('".implode("','", $DB->escape_str($entry_ids))."')
						ORDER BY e.entry_id ASC";
						
				$get_tags = $DB->query($sql);
					
				if($get_tags->num_rows > 0)
				{
					// Create an array with each entry_id as a key,
					// and an array of its tags as a value
					$tags = array();
					foreach($get_tags->result as $tag)
					{
						$tags[$tag['entry_id']][] = $tag['tag_name'];
					}

					// Build and run our update statement
					$sql = "UPDATE exp_weblog_data SET `field_id_".ceil($custom_field)."` = CASE entry_id ";
					foreach($tags as $entry_id => $tag)
					{
						$sql .= "WHEN ".$entry_id." THEN '".$DB->escape_str(implode(',', $tag))."' ";
					}
					$sql .= "END WHERE entry_id IN('".implode("','", $DB->escape_str($entry_ids))."')";
					
					$DB->query($sql);
					
					if($DB->affected_rows == 0)
					{
						// Everything was already in sync ('N Sync?)
						$message = $DSP->qspan('text', $LANG->line('nothing_to_sync'));
					}
					else
					{
						// We had updates
						$message = $DSP->span('text');
						$message .= $DB->affected_rows.' ';
						$message .= ($DB->affected_rows == 1) ? $LANG->line('entry') : $LANG->line('entries');
						$message .= ' '.$LANG->line('synced_in_batch');
						$message .= $DSP->span_c();
					}		
				}
				else
				{
					// None of the entries had tags - kinda redundant,
					// as we were only selecting entries with tags, but still...
					$message = $DSP->qspan('text', $LANG->line('nothing_to_sync'));					
				}

				if($current_batch < $batches)
				{
					// We have more batches to run
					$message .= ' '.$DSP->anchor(
						BASE.AMP.'C=admin'.
						AMP.'M=utilities'.
						AMP.'P=extension_settings'.
						AMP.'name=tag_sync'.
						AMP.'sync_weblog='.$sync_weblog.
						AMP.'batch='.($current_batch + 1), 
						$LANG->line('run_batch').' '.($current_batch + 1).' '.$LANG->line('of').' '.$batches.'.',
						'class="bold"'
					);
				}
				else
				{
					// We're all done!
					$message .= $DSP->qspan('success', ' '.$LANG->line('sync_complete'));
				}
			}
			else
			{
				// The weblog has no tagged entries
				$message = $DSP->qspan('alert', $LANG->line('no_entries'));
			}
		}
		// End synchronization routine
		
		// Start building the page
		$DSP->crumbline = TRUE;
		
		$DSP->title  = $LANG->line('extension_settings');
		$DSP->crumb  = $DSP->anchor(BASE.AMP.'C=admin'.AMP.'area=utilities', $LANG->line('utilities')).
		$DSP->crumb_item($DSP->anchor(BASE.AMP.'C=admin'.AMP.'M=utilities'.AMP.'P=extensions_manager', $LANG->line('extensions_manager')));
		$DSP->crumb .= $DSP->crumb_item($this->name);
		
		$DSP->right_crumb($LANG->line('disable_extension'), BASE.AMP.'C=admin'.AMP.'M=utilities'.AMP.'P=toggle_extension_confirm'.AMP.'which=disable'.AMP.'name='.$IN->GBL('name'));
		
		$DSP->body = '';
		
		if(isset($_GET['msg']) && $LANG->line($_GET['msg']))
		{
			$message = $DSP->qspan('success', $LANG->line($_GET['msg']));
		}
		
		// Do we have a message to show?
		if(isset($message))
		{
			$DSP->body .= $DSP->qdiv('box', $message);
		}
		
		$DSP->body .= $DSP->heading($this->name.NBS.$DSP->qspan('defaultLight', $this->version), 1);
		
		$DSP->body .= $DSP->form_open(
			array(
				'action' => 'C=admin'.AMP.'M=utilities'.AMP.'P=save_extension_settings',
				'name'   => 'tag_sync',
				'id'     => 'tag_sync'
			),
			array('name' => get_class($this))
		);
		
		// Open the table
		$DSP->body .=   $DSP->table('tableBorder', '0', '', '100%');
		$DSP->body .=   $DSP->tr();
		$DSP->body .=   $DSP->td('tableHeading');
		$DSP->body .=   ucfirst($PREFS->ini('weblog_nomenclature'));
		$DSP->body .=   $DSP->td_c();
		$DSP->body .=   $DSP->td('tableHeading', '', 2);
		$DSP->body .=   $LANG->line('tag_field');
		$DSP->body .=   $DSP->td_c();
		$DSP->body .=   $DSP->tr_c();
		
		// Display fair warning
		$DSP->body .=   $DSP->tr();
		$DSP->body .=   '<td class="box" style="border-width: 0 0 1px; margin: 0;" colspan="3">';
		$DSP->body .=   $DSP->qspan('highlight bold', $LANG->line('important')).' ';
		$DSP->body .=   $DSP->qspan('default', $LANG->line('warning'));
		$DSP->body .=   $DSP->td_c();		
		$DSP->body .=   $DSP->tr_c();

		// Get a list of weblogs
		$query = $DB->query("SELECT blog_title, weblog_id FROM exp_weblogs WHERE site_id = '".$DB->escape_str($PREFS->ini('site_id'))."' ORDER BY blog_title ASC");

		$i = 1;
		
		foreach($query->result as $row)
		{
			extract($row);
			$row_class = ($i % 2) ? 'tableCellTwo' : 'tableCellOne';
			
			// Get a list of text fields for this weblog			
			$sql = "SELECT f.field_id, f.field_label FROM exp_weblogs as w, exp_weblog_fields as f 
					WHERE w.field_group = f.group_id 
					AND w.weblog_id = $weblog_id 
					AND f.field_type IN ('text', 'textarea')
					ORDER BY f.field_order ASC";
					
			$results = $DB->query($sql);
			
			// Create a settings row for the weblog			
			$DSP->body .=   $DSP->tr();
			$DSP->body .=   $DSP->td($row_class, '45%');
			$DSP->body .=   $DSP->qdiv('defaultBold', $blog_title);
			$DSP->body .=   $DSP->td_c();
			
			$DSP->body .=   $DSP->td($row_class);
			$DSP->body .=   $DSP->input_select_header('weblog_id_'.$weblog_id, null, null, '200px');
			$DSP->body .=	$DSP->input_select_option('', '--');
			
			foreach($results->result as $value)
			{
				extract($value);
				$DSP->body .= $DSP->input_select_option($field_id, $field_label, ( isset($current['weblog_id_'.$weblog_id]) && $current['weblog_id_'.$weblog_id] == $field_id ) ? 1 : '');
			}
			
			$DSP->body .=   $DSP->input_select_footer();
			$DSP->body .=   $DSP->td_c();
			
			$DSP->body .=   $DSP->td($row_class.' defaultBold');
			// Should we display the sync link?
			if( isset($current['weblog_id_'.$weblog_id]) && !empty($current['weblog_id_'.$weblog_id]) )
			{
				$DSP->body .= $DSP->anchor(
					BASE.AMP.
					'C=admin'.
					AMP.'M=utilities'.
					AMP.'P=extension_settings'.
					AMP.'name=tag_sync'.
					AMP.'sync_weblog='.$weblog_id, 
					$LANG->line('sync_weblog').' '.$PREFS->core_ini['weblog_nomenclature']
				);
			}
			else
			{
				$DSP->body .= NBS;
			}
			$DSP->body .=   $DSP->td_c();
			$DSP->body .=   $DSP->tr_c();			
			
			$i++;
		}
		
		// Wrap it up
		$DSP->body .=   $DSP->table_c();
		$DSP->body .=   $DSP->qdiv('itemWrapperTop', $DSP->input_submit());
		$DSP->body .=   $DSP->form_c();	   			
	}
	
	
	function save_settings()
	{
		global $DB, $FNS;
		
		// Get the current settings, as we don't want to
		// overwrite other sites' settings
		$settings = $this->get_settings();
		
		unset($_POST['name']);
		
		// Add to the existing settings array
		foreach($_POST AS $weblog => $field)
		{
			$settings[$weblog] = round($field); // Insures that it is an integer
		}
		
		$data = array('settings' => addslashes(serialize($settings)));
		$update = $DB->update_string('exp_extensions', $data, "class = 'Tag_sync'");
		$DB->query($update);
		
		$FNS->redirect(BASE.AMP.'C=admin'.
							AMP.'M=utilities'.
							AMP.'P=extension_settings'.
							AMP.'name=tag_sync'.
							AMP.'msg=settings_saved'); 
							
		exit;
	}
	
	
	function get_settings()
	{
		global $DB, $REGX;

		$get_settings = $DB->query("SELECT settings FROM exp_extensions WHERE class = 'Tag_sync' LIMIT 1");
		if ($get_settings->num_rows > 0 && $get_settings->row['settings'] != '')
        {
        	$settings = $REGX->array_stripslashes(unserialize($get_settings->row['settings']));
        }
        else
        {
        	$settings = array();
        }
        return $settings;		
	}	
		

	function submit_new_entry_absolute_end($entry_id, $data)
	{
        global $DB;
        
        if($this->settings)
        {
	        $get_weblog = $DB->query('SELECT weblog_id FROM exp_weblog_titles WHERE entry_id = '.$entry_id);
	        
	        if( isset($this->settings['weblog_id_'.$get_weblog->row['weblog_id']]) && !empty($this->settings['weblog_id_'.$get_weblog->row['weblog_id']]) )
        	{
				$custom_field = $this->settings['weblog_id_'.$get_weblog->row['weblog_id']];
				
				$sql = "SELECT DISTINCT t.tag_name FROM exp_tag_entries AS e LEFT JOIN exp_tag_tags AS t ON e.tag_id = t.tag_id WHERE e.entry_id = ".$entry_id;
				$get_tags = $DB->query($sql);
				
				if($get_tags->num_rows > 0)
				{
					$tags = array();
					foreach($get_tags->result as $tag)
					{
						$tags[] = $tag['tag_name'];
					}

					// Update the field with our list of tags
					$sql = "UPDATE exp_weblog_data SET `field_id_".ceil($custom_field)."` = '".$DB->escape_str(implode(',', $tags))."' WHERE entry_id = $entry_id";
				}
				else
				{
					// We don't have any tags, or just removed them all, so zero out the field
					$sql = "UPDATE exp_weblog_data SET `field_id_".ceil($custom_field)."` = '' WHERE entry_id = $entry_id";
				}
				$DB->query($sql);		
			}
		}	
	}  
	
   
	// --------------------------------
	//  Activate Extension
	// --------------------------------
	
	function activate_extension()
	{
	    global $DB;

	    $hooks = array(
	    	'submit_new_entry_absolute_end' => 'submit_new_entry_absolute_end',
	    );
	    
	    foreach($hooks as $hook => $method)
	    {
		    $DB->query($DB->insert_string('exp_extensions',
		    	array(
					'extension_id' => '',
			        'class'        => 'Tag_sync',
			        'method'       => $method,
			        'hook'         => $hook,
			        'settings'     => '',
			        'priority'     => 10,
			        'version'      => $this->version,
			        'enabled'      => "y"
					)
				)
			);
	    }
	    
	}
	// END


	// --------------------------------
	//  Update Extension
	// --------------------------------  
	
	function update_extension($current='')
	{
	    global $DB;
	    
	    if ($current == '' OR $current == $this->version)
	    {
	        return FALSE;
	    }
	    
	    if($current < '1.0.5')
	    {
			// Zero the settings, as the field_id is stored as an integer now
			$data = array('settings' => serialize(array()));
			$update = $DB->update_string('exp_extensions', $data, "class = 'Tag_sync'");
			$DB->query($update);
		}
	    
	    $DB->query("UPDATE exp_extensions 
	                SET version = '".$DB->escape_str($this->version)."' 
	                WHERE class = 'Tag_sync'");
	}
	// END
	
	
	// --------------------------------
	//  Disable Extension
	// --------------------------------
	
	function disable_extension()
	{
	    global $DB;
	    
	    $DB->query("DELETE FROM exp_extensions WHERE class = 'Tag_sync'");
	}
	// END


}
// END CLASS