Module for auto-generation of path alias (beta)

One problem that I have not been able to solve, is that the help text of the Path alias-field should be changed to tell what happens if the field is left empty.

killes outlines a solution in http://drupal.org/node/14597 , but I don't understand it. Anyone able to explain in more detail.

See http://drupal.org/node/15814 for an alternative solution to this problem.

In order to accommodate the different wishes on how the path should look, I have partially rewritten the module and changed the interface so that you now provide a pattern for your path, using placeholders for the dynamic parts.

The available placeholders are listed at the settings page, and it's fairly easy to add more.

Unfortunately I have not found any way to add a holder for the node id, since this does not seam to have been created at preview time.

A [module] placeholder would be nice to have, but I have not been able to figure out a good way to do this. Same with a [breadcrumbs] (that would transform the pages breadcrumbs into a path).

The placeholder [categorybreadcrumbs] gives a path with the category and all ancestors to it. The name "categorybreadcrumbs" is clumsy, so suggestions for a better name would be appreciated.

I have also changed the way the module behaves if the path already exists. Now it adds a serial number at the end of the path.

I have not had the opportunity to test the code with sites that has none or just one vocabulary. If you do that, please write a comment and tell if it works.

// $Id: path_automatic_automatic.module,v 0.2 2005/01/24 21:22:26 Tommy Sundström Exp $


/** 
 * This module auto-generates a path alias.
 *
 * It needs path.module in order to work.
 */
 
/**
 * Implementation of hook_help().
 *
 */
function path_automatic_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      // This description is shown in the listing at admin/modules.
      return t('If the path module is active, renames the URLs automaticly.');
  }
}  



/**
  * Settings for how the path will get generated. 
	*/	
function path_automatic_settings() { 
  if (module_exist(path)) {
	  if (user_access('create url aliases') || user_access('administer url aliases')) {
		  $vocabularies = taxonomy_get_vocabularies();
			
		
		
		  // Generate the form
			$description = 'Write the path as you want it, using the following placeholders.';
			$description .= '<dl>';
			
			$description .= '<dt>'.'[title}'.'</dt>';
			$description .= '<dd>'.t('The title of the page, transformed so that it can be used in an url').'</dd>';
			
			if (sizeof($vocabularies) > 0) {
				$description .= '<dt>'.'[category]'.'</dt>';
				$description .= '<dd>'.t('The category that the page belongs to (in case it belongs to several, the first is used).');
				if (sizeof($vocabularies) > 1) {
					$description .= t(' If there are more than one vocabulary you must choose the one to be used with the control below.');
				}
				$description .= '</dd>';
			}							
		
			$description .= '<dt>'.'[categorybreadcrumbs]'.'</dt>';
			$description .= '<dd>'.t('As category, but all supercategories is included in path.').'</dd>';
			
			$description .= '<dt>'.'[year]'.'</dt>';
			$description .= '<dd>'.t('A full numeric representation of a year, 4 digits	Examples: 1999 or 2003').'</dd>';
			
			$description .= '<dt>'.'[month]'.'</dt>';
			$description .= '<dd>'.t('Numeric representation of a month, with leading zeros	01 through 12').'</dd>';
			
			$description .= '<dt>'.'[monthShort]'.'</dt>';
			$description .= '<dd>'.t('A short textual representation of a month, three letters	Jan through Dec').'</dd>';
			
			$description .= '<dt>'.'[day]'.'</dt>';
			$description .= '<dd>'.t('Day of the month, 2 digits with leading zeros	01 to 31').'</dd>';
			
			$description .= '<dt>'.'[dayShort]'.'</dt>';
			$description .= '<dd>'.t('A textual representation of a day, three letters	Mon through Sun').'</dd>';
			
			$description .= '<dt>'.'[hour]'.'</dt>';
			$description .= '<dd>'.t('24-hour format of an hour with leading zeros	00 through 23').'</dd>';
			
			$description .= '<dt>'.'[minute]'.'</dt>';
			$description .= '<dd>'.t('Minutes with leading zeros	00 to 59').'</dd>';
			
			$description .= '<dt>'.'[second]'.'</dt>';
			$description .= '<dd>'.t('Seconds, with leading zeros	00 through 59').'</dd>';
			
			$description .= '<dt>'.'[week]'.'</dt>';
			$description .= '<dd>'.t('Week number of year, weeks starting on Monday.	Example: 42 (the 42nd week in the year)').'</dd>';						
			
			/*
			$description .= '<dt>'.'[]'.'</dt>';
			$description .= '<dd>'.t('').'</dd>';
			*/
			
			$description .= '</dl>';
			
			// Since the node id is not known at preview time, I have not found any way to make a placeholder for it.
			// To make more date formats, see http://se2.php.net/manual/en/function.date.php
			
			$output = form_textfield( 'Pattern for the path', 
										 					  'path_automatic_pathpattern', 
										 					  variable_get('path_automatic_pathpattern','{$title}'), 
										 						100, 
										 						6000, 
										 						$description, 
										 						NULL, 
										 						FALSE);
			
			
			
			
			// Ask about what vocabulary are to be used			
			switch (sizeof($vocabularies)) {
			  case 0: // No vocabulary
				  variable_set('path_automatic_vocabulary', NULL);
				  break;
			  case 1: // Just one vocabulary, nothing to choose between
				  variable_set('path_automatic_vocabulary', $vocabularies[0]->vid);
					break;
				default:
			  	$options = array();
			    $description = '<br /><dl>';
				  foreach($vocabularies as $vocabulary) {
					  $options[$vocabulary->vid] = $vocabulary->name;
						if ($vocabulary->description){
						  $description .= '<dt>'.$vocabulary->name.'</dt>';
				      $description .= '<dd>'.$vocabulary->description.'</dd>';
						}	
					}
					$description .= '</dl>';

					$output .= form_select(t('Choose the vocabulary to be used for {$category}'), 
							'path_automatic_vocabulary', 
							variable_get('path_automatic_vocabulary','0'), 
							$options,
							$description
							);
					break;
				}														
		}
		else {
		  $output = t('You need permission from the path module to <i>create url aliases</i> or <i>administer url aliases</i> for this module to work');
		}
	}
	else {
	  $output = t('This module requires that the path module <a href="/admin/modules">is activated</a>.');
	} 
	return $output;
} 

/**
 * Implementation of hook_nodeapi().
 *
 * Allows URL aliases for nodes to be specified at node edit time rather
 * than through the administrative interface.
 */
function path_automatic_nodeapi(&$node, $op, $arg) {
  if (module_exist(path) && (user_access('create url aliases') || user_access('administer url aliases'))) {
    switch ($op) {
      case 'validate':
			  // (This is not realy validation, but this is the best place to patch in this funtionality.)
			
        $node->path = trim($node->path);
				
				// If no path alias is given, auto generates a path alias.
				if (!$node->path) {
				  // No path. Autogenerating it.
					
					// Generate the placeholders
					$placeholders = array();
					
					// [title]
					$txt = stringToPath($node->title);
					if ($txt == '***NOT_VALID***') {$txt = '';} // The stringToPath has failed. 
					$placeholders['[title]']  = $txt;
					
					// [category] & [categorybreadcrumbs]
					$vid = variable_get('path_automatic_vocabulary', NULL);
					if ($vid && $node->taxonomy) {
					  $termids = $node->taxonomy;
						foreach($termids as $tid) {
						  $term = taxonomy_get_term($tid);
							if ($term->vid == $vid){
							  $termname = $term->name;
								break; // (only the first is needed. $tid will be used again below)
							}
						}						
						$txt = stringToPath($termname);  						
						if ($txt == '***NOT_VALID***') {$txt = '';} // The stringToPath has failed. 					
						$placeholders['[category]']  = $txt;
						
						$crumbstxt = '';
						$ancestors = taxonomy_get_parents_all($tid);
						foreach ($ancestors as $ancestor) {
						  $txt = stringToPath($ancestor->name);
							if ($txt == '***NOT_VALID***') {$txt = '';} // The stringToPath has failed. 
						  $crumbstxt  = $txt . '/' . $crumbstxt;
						}
						$placeholders['[categorybreadcrumbs]']  = $crumbstxt;
					} else {
					  $placeholders['[category]']  = '';
						$placeholders['[categorybreadcrumbs]']  = '';
					}
					
					// Date & other time info
										
					$placeholders['[year]'] 				= date('Y', $node->created);
					$placeholders['[month]'] 				= date('m', $node->created);
					$placeholders['[monthShort]'] 	= strtolower(date('M', $node->created));
					$placeholders['[day]'] 					= date('d', $node->created);
					$placeholders['[dayShort]'] 		= strtolower(date('D', $node->created));
					$placeholders['[hour]'] 				= date('H', $node->created);
					$placeholders['[minute]'] 			= date('i', $node->created);
					$placeholders['[second]'] 			= date('s', $node->created);
					$placeholders['[week]'] 				= date('W', $node->created);
					
					// Construct the path
					$pathpattern = variable_get('path_automatic_pathpattern','{$title}');
					$path = str_replace(array_keys($placeholders), $placeholders, $pathpattern);
					
					// Cleanup path and check that it's unique
					// Two or more slashed should be colapsed into one
        	$path = preg_replace("/\/+/", "/", $path);
        	// Trim any leading or trailing slashes
        	$path = preg_replace("/^\/|\/+$/", "", $path);
					
					// If the path already exists, generate a new variant
					if (path_automatic_check_if_already_in_use($path, "node/$node->nid")) {
							for ($i=1; path_automatic_check_if_already_in_use($path."-".$i, "node/$node->nid"); $i++) {
							}
							$path = $path.'-'.$i;
					}					
					$node->path = $path;																
				}
			}
		}
	}
							
						

/** 
 * Clean a string so that it can be used as a path.
 */

function stringToPath($str) {
  $str = strip_tags($str);
						
	// Accented characters					
	$from = 'ŠŽšžŸÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖØÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöøùúûüýÿ';
	$to   = 'SZszYAAAAAACEEEEIIIINOOOOOOUUUUYaaaaaaceeeeiiiinoooooouuuuyy';
	for ($n=0; $n < strlen($to); $n++) {
		$str=str_replace(utf8_encode(substr($from, $n, 1)), substr($to, $n, 1), $str);
		}
	// Interpunction etc
	$str = preg_replace("/[ \/_]/", "-", $str);  // replace with dash
	$str = preg_replace("/[.,:;!?¤%&(){}@£$€<>|=*[\]\"\'\\\\]/", "", $str); // remove 
	$str = preg_replace("/-+/", "-", $str); // collapse mulitple dashes into one
	// todo: trim away dashes
	$str = trim($str);
	$str = strtolower($str);
	$str = urlencode($str); 
	if (!valid_url($str)) {
		// valid_url will not accept all urls that urlencode can generate (it does not seam to accept the %-encoding)
		// This should be a rare problem, but to be sure, skip path generation when this is the case.
		// (It will only be the case when the title contains other characters than a-z and the ones transformed above.)
		return ('***NOT_VALID***'); 
		}
	return ($str); 
}

 

/** 
 * Check that a path alias is not already in use.
 */
function path_automatic_check_if_already_in_use($aliaspath, $realpath) {
  if (db_result(db_query("SELECT COUNT(dst) FROM {url_alias} WHERE dst = '%s' AND src != '%s'", $aliaspath, $realpath))) {
	  return TRUE; // In use
	} 
	else {
	  return FALSE; // Free to use
	}
}

This module is merging with Autopath. See http://drupal.org/node/16035