<?php #if (!defined('PmWiki')) exit();
/*  Copyright 2007 Michael P Majorowicz
    This file is router.php; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published
    by the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.  
*/
/** \file router.php
 * \brief Router allows a website's url structure to be different from PmWiki's group/page structure.
 *
 * See: http://www.pmwiki.org/wiki/Cookbook/Router for installation and usage instructions
 *
 * 
 */

$RecipeInfo['Router']['Version'] = '2007-12-19r12beta';
RoutePreProcess();

$FmtPV['$PageUrl']='RoutedUrl($group,$name)';
$FmtPV['$GroupUrl']='RoutedGroupUrl($group)';


///
/// Controls processing of inbound link
///
function RoutePreProcess() {
  global $aRoute,$pagename,$RouteOriginal;
  $RouteOriginal=$pagename;
  $pagename=RouteLoop($pagename,'In');
  $aRoute=array_reverse($aRoute,TRUE);
}
///
/// Converts a group name into an outbound link for $GroupUrl page variable
///
function RoutedGroupUrl($group) {
  global $DefaultGroup,$DefaultName;
  
  if ($group==$DefaultGroup) {
    return RoutedUrl($DefaultGroup,$DefaultName);
  }
  return RoutedUrl($group,$group);
}
///
/// Converts a group/page pair into an outbound link for $PageUrl page variable
/// Caches routed urls in a static array
///
function RoutedUrl($group,$name) {
  static $aurlcache=array();
  global $aRoute,$EnablePathInfo,$ScriptUrl;
  
  $path="$group.$name";
  if ($EnablePathInfo) {
    $path="$group/$name";
  }
  $pathkey=$path; #pathkey also used for saving to cache below
  if (array_key_exists($pathkey,$aurlcache)) {
    return $aurlcache[$pathkey];
  }
  $path=RouteLoop($path,'Out');
  $url=$ScriptUrl.'?n='.$path;
  if ($EnablePathInfo) {
    $url=$ScriptUrl.'/'.$path;
  }
  if (''==$path) {
    $url=$ScriptUrl;
  }
  $aurlcache[$pathkey]=PUE($url);
  return $aurlcache[$pathkey];
}
///
/// Loops through configured routing instructions for both inbound and outbound links
///
function RouteLoop($path,$direction) {
  global $aRoute;
  foreach ($aRoute as $k=>$v) {
    $aline=array();
    if (is_array($v)) {
      $aline=$v;
      #is instuction limiting processing to one direction
      if (array_key_exists('Direction',$aline)) {
        if ($direction!=$aline['Direction']) {
          continue;
        }
      }
    } else {
      #default to basic instruction format
      $aline['Mode']='BeginsWith';
      $aline['PageName']=$k;
      $aline['Url']=$v;
    }
    $aline['Direction']=$direction;
    if (!array_key_exists('Mode',$aline)) {
      continue;
    }
    $modefunc='RT_'.$aline['Mode'];
    if (!function_exists($modefunc)) {
      continue;
    }
    $path=$modefunc($path,$aline);
  }
  return $path;
}
///
/// Determines search and replace values based on inbound/outbound direction of 
/// the link being processed
///
function RouteGetSearchReplace($aline) {
  if ('Out'==@$aline['Direction']) {
    return array(
      @$aline['PageName'] #search
      ,@$aline['Url'] #replace
    );
  }
  return array(
    @$aline['Url'] #search
    ,@$aline['PageName'] #replace
  );
}
///
/// For a match, the search value must start at the beginning of the path.
///
function RT_BeginsWith($path,$aline) {
  list($search,$replace)=RouteGetSearchReplace($aline);
  if (strpos($path,$search)===0) {
    $path=substr_replace($path,$replace,0,strlen($search));
  }
  return $path;
}
///
/// For a match, the search value can be found anywhere in the path
///
function RT_Contains($path,$aline) {
  list($search,$replace)=RouteGetSearchReplace($aline);
  $path=str_replace($search,$replace,$path);
  return $path;
}
///
/// For a match, the search value must be at the end of the path
///
function RT_EndsWith($path,$aline) {
  list($search,$replace)=RouteGetSearchReplace($aline);
  if (substr($path,-strlen($search))===$search) {
    $path=substr_replace($path,$replace,-strlen($search),strlen($search));
  }
  return $path;
}
///
/// For a match, the search value must be exactly equal to the path
///
function RT_ExactMatch($path,$aline) {
  list($search,$replace)=RouteGetSearchReplace($aline);
  if ($path==$search) {
    return $replace;
  }
  return $path;
}
///
/// Process a search/replace pair with preg_replace()
///
function RT_RegReplace($path,$aline) {
  if (!array_key_exists('Search',$aline) or !array_key_exists('Replace',$aline)) {
    return $path;
  }
  $limit=-1;
  if (array_key_exists('Limit',$aline)) {
    $limit=$aline['Limit'];
  }
  $path=preg_replace($aline['Search'],$aline['Replace'],$path,$limit);
  return $path;
}
///
/// Converts between lower-case-urls and CamelCase page names
///
function RT_CamelCaseToLowerCase($path,$aline) {
  if('In'==@$aline['Direction']) {
    $path=strtr($path,array('-'=>' ','/'=>"\t",'.'=>"\t"));
    $path=ucwords($path);
    $path=strtr($path,array(' '=>'',"\t"=>'/'));
    return $path;
  }
  $path=addcslashes($path,'A..Z');
  $path=strtr($path,array('/\\'=>'/','\\'=>'-'));
  $path=strtolower($path);
  $path=ltrim($path,'-');
  return $path;
}