modules/filebrowser_extensions/filebrowser_extensions.module

<?php
// $Id: filebrowser_extensions.module,v 1.11 2006/11/19 10:51:58 dman Exp $

/**
 * @file
 * Allows configurable and context-sensitive uses of the filebrowser
 * functionality
 * 
 * See the readme for extended usage instructions.
 * 
 */

require_once('filebrowser_cells.php');

/**
 * Implementation of hook_help().
 */
function filebrowser_extensions_help($section = NULL) {
  switch ($section) {
    case 'admin/modules#description':
      return t('Extends Filebrowser with inline directory listings, pop-ups and AJAX.');
      break;
    case 'admin/help#filebrowser_extensions':
      // include dirname(__FILE__)."/filebrowser_demo.inc";
      return  _filter_autop( drupal_eval( file_get_contents( dirname(__FILE__)."/README.txt") ) ); // . filebrowser_demo() ;
    case 'admin/settings/filebrowser_extensions':
      return t("<p>
        A <em>Filebrowser Profile</em> is a set of rules that allow file browsing in
        specified directories with given parameters. 
        </p>
        <p>Different profiles can be given different root directories, different
        rendering options and different access permissions. 
      </p>
      <p><a href='%help_link'>More Help and examples</a></p>
      ",array('%help_link'=>url('admin/help/filebrowser_extensions'))
      );
  }
}


/**
 * Implementation of hook_menu().
 * 
 * A new 'filebrowser_list' page becodes available, an alternate theme to the
 * normal filebrowser table.
 * Some callbacks to support AJAX lookups are supplied.
 * 
 * Two autocomplete responders are published also: filebrowser/autocomplete and
 * filebrowser/autocomplete_directory can be used as autocomplete handlers in
 * form building.
 */
function filebrowser_extensions_menu($may_cache=FALSE) {
  $items = array();
  if($may_cache){ 
    $items[] = array('path' => 'filebrowser_popup', 'title' => t('filebrowser popup'),
      'access' => user_access('access filebrowser'), 'callback' => 'filebrowser_custom_page',
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'filebrowser_list', 'title' => t('filebrowser list'),
      'access' => user_access('access filebrowser'), 'callback' => 'filebrowser_custom_page',
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'filebrowser_autocomplete_directory',
      'title' => t('autocomplete filebrowser'),
      'callback' => 'filebrowser_autocomplete_directory',
      'access' => user_access('access filebrowser'),
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'filebrowser_autocomplete',
      'title' => t('autocomplete filebrowser'),
      'callback' => 'filebrowser_autocomplete',
      'access' => user_access('access filebrowser'),
      'type' => MENU_CALLBACK);
  }
    // add the dynamic paths
    $profiles = variable_get('filebrowser_profiles',array());
    foreach($profiles as $id => $profile){
      $items[] = array('path' => $profile['path'],
        'title' => $profile['title']?$profile['title']:$profile['path'],
        'callback' => 'filebrowser_custom_page',
        'access' => user_access('access filebrowser'),
        'type' => MENU_SUGGESTED_ITEM);
    }
    
  return $items;
}

/**
 * Interface to configure the filebrowser view profiles.
 * 
 * A filebrowser profile specifies the root directory, the authentication, and
 * the columns that can show up as part of a filebrowser request.
 */
function filebrowser_extensions_settings(){
  $filebrowser_profiles = variable_get('filebrowser_profiles',array());

  $settings_form = array();
  
  if($_REQUEST['create']){
    $filebrowser_profiles[$_REQUEST['create']] = array(
      'path' => $_REQUEST['create'],
      'root' => file_directory_path(),
      'cols' => 'expander;file;size',
      'serve_as_drupal_files' => TRUE,
      'blacklist' => '.htaccess',
      'hide_directories' => false,
    );
    drupal_set_message(t("A new profile has been filled in below. <strong>Save it</strong> then visit the link it publishes." ));
  }
  else if(empty($filebrowser_profiles)){
    $settings_form['sample'] = array('#value' => t(
      "<a href='%sample_link'>Create a sample profile</a> to get started.",
      array('%sample_link' => url('admin/settings/filebrowser_extensions','create=browse_files'))
    ));
  }
  
  $profiles_form = array(
    '#tree' => TRUE,
  );
  foreach($filebrowser_profiles as $id => $profile){
    $profiles_form[$id] = _filebrowser_profile_form($profile);
  }
  $profiles_form['_new'] = _filebrowser_profile_form(array());
  
  $settings_form['filebrowser_profiles'] = $profiles_form;
  $settings_form['filebrowser_icons'] = array(
      '#type' => 'textfield',
      '#title' => t('Icon directory'),
      '#default_value' => variable_get('filebrowser_icons', drupal_get_path('module','filebrowser_extensions').'/contrib/icons' ),
      '#maxlength' => '100',
      '#size' => '70',
      '#autocomplete_path' => 'filebrowser_autocomplete',
      '#description' => t('Name of directory where file type icons are stored. <br/>Files should be named "file-txt.png", "file-gif.png", etc. The default icon is "file-default.png".')
    );
  
  
  return $settings_form;
}

function _filebrowser_profile_form($profile){
  $form = array(
    '#type' => 'fieldset',
    '#title' => $profile['path'] ? t("Filebrowser instance for '"). $profile['path'] ."'": t("New Filebrowser profile"),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
 
 
  if($profile['path']){
    $form['summary'] = array( '#value' => t("<p>
      This filebrowser instance publishes the files stored at
      <code><strong>%completepath</strong></code> under the URL 
      <code><strong>%path</strong></code>.
      <br/>Clicking on files presented like that
      will invoke a request to paths underneath
      <code><strong>%rel_url</strong></code> .</p>
      <h2>Link to: %link</h2>
      <p>The menu system should be displaying a 'suggested item'
      that can be enabled to link to this utility.
      </p>
  
    ", array(
      '%completepath' => $profile['serve_as_drupal_files']?file_create_path($profile['root']):( ($profile['root'][0]=='/')? $profile['root'] : '[SITEROOT]'.$profile['root']) ,
      '%path' => url($profile['path']),
      '%link' => l($profile['path'],$profile['path']),
      '%rel_url' =>  file_create_url($profile['rel_url']),
    )));
  } 
 
  $form['path'] = array(
    '#type' => 'textfield',
    '#title' => 'path',
    '#default_value' => $profile['path'],
    '#description' => t("
        The URL alias this browse function will be published under. 
        eg <b>browse_files</b>. 
        Subdirectories will naturally be accessible underneath this root path.
    "),
  );
  if(is_array($profile['cols']))$profile['cols']=join(';',$profile['cols']);
  $form['cols'] = array(
    '#type' => 'textfield',
    '#title' => 'columns',
    '#default_value' => $profile['cols']?$profile['cols']:"icon;name;size",
    '#description' => t("
        List the desired columns or cells, separated by semicolons
    "),
  );
  $columns = array(
    'name','file','size','age','date','info','type','filename','checkbox','select_button','expander'
  );
  foreach($columns as $a => $d){
    // ask the cells to describe themselves
    $f = 'filebrowser_get_cell_'.$d;
    if(function_exists($f)){
      $header = $f('',NULL);
      $col_descriptions[$d] = "<b>$d</b> : ".$header['description'];
    }
  }
  
  $form['about_cols'] = array(
    '#type' => 'fieldset',
    '#title' => t('About columns...'),
    '#collapsed' => TRUE, '#collapsible' => TRUE,
    'list' => array(
      '#value' => theme('item_list',$col_descriptions,'Available columns include:'),
    )
  );


  $form['root'] = array(
    '#type' => 'textfield',
    '#title' => 'Actual browse root',
    '#default_value' => $profile['root'],
    '#description' => t("
        File path to the top of all directories that can be browsed using this 
        method. 
        Either <acronym title='/usr/me/my_files'>filesystem-absolute</acronym>,
        <acronym title='files/images/shared'>drupal-root-relative</acronym>,
        or <acronym title='images/public (with Drupal file server checked)'>files-dir-relative</acronym> 
        (check below). 
    ")
  );

  $form['whitemask'] = array(
    '#type' => 'textfield',
    '#title' => 'Glob pattern (which files to show)',
    '#default_value' => $profile['whitemask'],
    '#description' => t("
        A Regular Expression matching wanted files.
        eg: <code>.*\\.jpg|gif</code>.
        If blank, all files will be selected. Default: <code>.*</code>
    ")
  );
  $form['blacklist'] = array(
    '#type' => 'textfield',
    '#title' => 'Blacklist of files to hide',
    '#default_value' => $profile['blacklist'],
    '#description' => t("
        Filenames separated by semicolons,
        eg: <code>.htaccess;descript.ion;CVS</code>.
        If blank, no files will be hidden.
    ")
  );

/*
  $parameters = array(
    '%path' => t("Current context node path, eg about/us . Gets filled in when called from a node context."),
    '%userid' => t("Current userid."),
    '%files' => t("System file directory path ") . file_directory_path(),
    '%type' => t("Current node type"),
  );
  foreach($parameters as $a => $d){
    $parameters[$a] = "<b>$a</b> : $d";
  }
  
  $form['parameters'] = array(
    '#value' => theme('item_list',$parameters, t("Available path variables are:")),
  );
*/
  $form['recursive'] = array(
    '#type' => 'checkbox',
    '#title' => 'Display all contents recursively.',
    '#default_value' => $profile['recursive'],
    '#description' => t("
        This can lead to intensive page requests. 
        Can be over-ridden on demand from the pages themselves
    ")
  );
  $form['hide_directories'] = array(
    '#type' => 'checkbox',
    '#title' => 'don\'t display subdirectories at all.',
    '#default_value' => $profile['hide_directories'],
    '#description' => t("
        This will over-ride the recursive option.
    ")
  );
  $form['show_uplinks'] = array(
    '#type' => 'checkbox',
    '#title' => 'show links to allow navigation to higher directories (up to this contexts root).',
    '#default_value' => $profile['show_uplinks'],
    '#description' => t("
      Although the root setting controls the actual security of what people can see, some uses
      - like directory attachments - don't really require 'parent' links. 
      Uncheck this to disallow up navigation.
    ")
  );

  $form['serve_as_drupal_files'] = array(
    '#type' => 'checkbox',
    '#title' => 'Use the Drupal file server to resolve how the files get served.',
    '#default_value' => $profile['serve_as_drupal_files'],
    '#description' => t("
        This is required if files are served using Drupal 'private' mechanism, 
        or the real file root is above the Drupal base. 
        Can also be used to redirect to an FTP server or virtual directories.
    ")
  );

  $form['rel_url'] = array(
    '#type' => 'textfield',
    '#title' => 'Presented URL base',
    '#default_value' => $profile['rel_url'],
    '#description' => t("Base URL path to publish the above found files as.")
  );

  $form['render'] = array(
    '#type' => 'select',
    '#title' => 'Render method.',
    '#default_value' => $profile['render'],
    '#options' => array('list'=>'list','table'=>'table','popup'=>'popup'),
  );
  $form['help'] = array( '#value' => t("<p>
    To <b>delete</b> a profile, clear its 'path' parameter and save.
  </p>"));

  return $form;
}

function filebrowser_extensions_settings_form_validate($form_id, $form_items){
  if(! is_dir($form_items['filebrowser_icons'])){
    form_set_error('filebrowser_icons','Folder '.$form_items['filebrowser_icons'].' does not exist');
  }
}

/**
 * Re-indexes the profiles and discards invalid ones
 */
function filebrowser_extensions_settings_form_submit($id,$form_values){
  // Ensure indexing/labelling is correct
  $profiles = $form_values['filebrowser_profiles'];
  foreach($profiles as $id => $profile){
    unset($profiles[$id]);
    if($profile['path']){
      $profiles[$profile['path']] = $profile;
    }
  }
  variable_set('filebrowser_profiles',$profiles);
  variable_set('filebrowser_icons',$form_values['filebrowser_icons']);
}


/**
* Implementation of hook_perm().
*/
function filebrowser_extensions_perm() {
  return array('access filebrowser');
}

/** 
 * Return the context (custom filebrowser path) to be used by the current
 * request.
 * 
 * Figure it either from the directly given _REQUEST parameter, or from working
 * backwards from the requested subsection.
 */
function filebrowser_deduce_context($subfolder){
  // Our full URL, minus our argument = the current filebrowser context. Unless clean-urls are off
  $context = $_REQUEST['context'] ? $_REQUEST['context'] : ( $_REQUEST['subsection'] ? $_GET['q'] : filebrowser_split_base($subfolder) );
  $context = trim($context,'/');
  return $context;
}

/**
 * fetch the default profile, or the requested one, or SET it.
 * 
 * Applies to this pageload only, and is used by other cell functions
 * that want to know what's up.'
 * This remembers the last profile fetched, and will return it again if called
 * with no parameters.
 */
function filebrowser_profile($context=NULL,$p=NULL,$save=FALSE){
  static $profile;
  if($context){
    $profiles = variable_get('filebrowser_profiles',array());
    $profile = $profiles[$context];

    if(!$profile && ($context == ('filebrowser_popup'))){
      // hard-code special case
      filebrowser_set_profile_defaults($profile);
      $profile['path'] = 'filebrowser_popup';      
      $profile['render'] = 'popup';      
      $profile['cols'] = 'expander;file;select_button';      
    }
    filebrowser_set_profile_defaults($profile);
  }
  if($p){
    $profile = $p;
    filebrowser_set_profile_defaults($profile);
  }
  if($context && $save){
    $profiles[$context] = $profile;
    variable_set('filebrowser_profiles',$profiles);
  }

  return $profile;
}

/**
 * Ensure the given profile has suitable defaults.
 * Operates by handle
 */
function filebrowser_set_profile_defaults(&$profile){
  // Recursive is either defined in the profile or over-ridden in the request
  $profile['recursive'] = $_REQUEST['edit']['recursive'] ? $_REQUEST['edit']['recursive'] : $profile['recursive'];

  $profile['path'] = isset($profile['path'])?$profile['path'] : 'filebrowser_list';
  // ensure the rest of profile has meaningful values
  $profile['render']    = $profile['render'] ? $profile['render'] : 'list';
  if(! is_array($profile['cols']))
    $profile['cols']      = $profile['cols'] ? array_map('trim', (split(";",$profile['cols']))) : array('icon','name');
  $profile['root']      = $profile['root'] ? $profile['root'] : file_directory_path();
  $profile['rel_url']   = isset($profile['rel_url']) ? $profile['rel_url'] : ($profile['serve_as_drupal_files'] ? file_create_url('') : file_directory_path()) ;

  $profile['show_uplink'] = isset($profile['show_uplink']) ? $profile['show_uplink'] : TRUE;

  $profile['whitemask'] = $profile['whitemask'] ? $profile['whitemask'] : '.*';
  $profile['blacklist_a'] = $profile['blacklist'] ? split(';',$profile['blacklist']) : array('CVS');
  array_push($profile['blacklist_a'], '.');
  array_push($profile['blacklist_a'],'..');

  return $profile;  
}

//////////////////////////////////////////////////////
// end admin, begin list & render
//////////////////////////////////////////////////////


/** 
 * Generic callback for custom profile filebrowser pages.
 * 
 * This is the core function of the whole module.
 * 
 * Renders a filebrowser page with the appropriate parameters.
 * Configs are from the profile maintainded in filebrowser_estension settings.
 * 
 * The context is calculated from the request, or optionally may be given via a
 * 'context=' parameter
 * @param $subfolder
 */
function filebrowser_custom_page(){
  $parts = func_get_args();
  $subfolder = join('/',$parts);
  // subfolder is always from the users POV, despite what the actual paths may be
  $subfolder = $subfolder?$subfolder:$_REQUEST['subsection'];

  // Set context for later filebrowser links. Need to be self-aware.
  if(!filebrowser_profile()){
    $context = filebrowser_deduce_context($subfolder);
    $profile = filebrowser_profile($context);
  }
  // calling filebrowser_profile also memos the default/current profile.

  if(! $profile){
    drupal_set_message($subfolder.' ['.$context.']' . t(" is not correctly configured for filebrowser access. No browse profile seemed to match this request."));
    return drupal_access_denied();
  }
  
  // todo - check auth here

  $completepath = filebrowser_create_path($subfolder,$profile);

#  dsm($profile);
#  dsm("context is $context");
#  dsm("subfolder is $subfolder");
#  dsm("completepath is $completepath");

  filebrowser_set_breadcrumbs($subfolder);
  drupal_set_title( t("Files in <code title='%long_path' >%subfolder</code>" ,
    array('%long_path'=>$completepath,'%subfolder'=>($subfolder?$subfolder:'filebrowser root')) 
  ));


  // Ready to scan...
  if (! is_dir($completepath)) {
    drupal_set_message(t("$completepath is not a directory available for browsing for this user"));
    if ( is_file($completepath)) {
      drupal_set_message(t("It's a file, and may possibly be accessed at ". l( $subfolder,filebrowser_file_url($subfolder) ) ));
    }
    return "sorry";
  }

  /////////////////
  // Scan here
  /////////////////
  $dir_structure = file_scan_directory($completepath,$profile['whitemask'],$profile['blacklist_a'],NULL,$profile['recursive']) ;

  if (!$dir_structure) {
    drupal_set_message(t("Unable to get files for this directory '$subfolder'"));
    return "sorry";
  }

  if( ($subfolder != '') && ($subfolder != '.') && ($_REQUEST['mode']!='raw')){ 
    // Add uplink
    if($profile['show_uplinks']){
      $dir_structure['..'] = (object)array(
        'filename'=>dirname($completepath),
        'basename'=>t('..up to "%parentname"', array('%parentname' => basename(dirname($completepath))) ),
      );
    }
  }

  #dsm($dir_structure);
  $tree = filebrowser_sort_list_into_tree($dir_structure,$profile['root'],$subfolder);
  #dsm($tree);

  # $output = "displaying ".join(", ",$profile['cols']);

  $form = filebrowser_construct_form($tree,$profile);

  if($_REQUEST['mode']=='raw'){
    /////////////////
    // Being called as a subrequest
    // (Not allowed to nest forms, so rendering must differ.) 
    // form_render() invocation does the layout (including sorting), but not form header.
    $output = form_render($form); 
    $output = $output ? $output : t("[Empty Folder] <a title='$completepath'>$subfolder</a> ");
    print $output;
    exit();
  }
  else if(($profile['render']== 'popup')){
    /////////////////
    // Render without much chrome
    /////////////////
    
    $bread = drupal_get_breadcrumb(); 
    array_shift($bread); 
    $output = theme('filebrowser_breadcrumb',$bread); 
    
    $output .= drupal_get_form('tree',$form);
   
    if($_REQUEST['mode']=='in-place'){
      print $output;
      return NULL;
    }

    include(dirname(__FILE__)."/filebrowser-popup.tpl.inc");
    return NULL;
  }
  else {
    /////////////////
    // this version returns a whole form, as a page 
    /////////////////
    $output .= drupal_get_form('tree',$form);
    return theme('filebrowser',$output);
  }
}


function filebrowser_construct_form($tree,$profile){
  
  if($profile['render']== 'list'){
    /////////////////
    // Render as list
    /////////////////
    $form = array(filebrowser_tree_to_rows($tree,$profile['cols']));
  }
  else {
    /////////////////
    // Render as table
    /////////////////
    // Prepare headers for display (ask the functions themselves what they are called)
    $headers = array_map(
      create_function(
        '$colname',
        '$func = "filebrowser_get_cell_".$colname; if(function_exists($func))return $func(""); '
      ),
      $profile['cols']
    ); 

    $form = array( filebrowser_tree_to_tables($tree,$profile['cols']) ) ; 
  }
  
  return $form;
}

function filebrowser_embed($subfolder='',$profile=array()){
  static $count;
  $context = $profile['path'];

  filebrowser_set_profile_defaults($profile);  
  // set context
  // we need to make a dummy callback to serve the 
  // later ajax requests for this item
  filebrowser_profile($context,$profile,TRUE);
  $completepath = filebrowser_create_path($subfolder,$profile);

  // scan & render
  $dir_structure = file_scan_directory($completepath,$profile['whitemask'],$profile['blacklist_a'],NULL,$profile['recursive']) ;

  $tree = filebrowser_sort_list_into_tree($dir_structure,$profile['root'],$subfolder);
  $form = filebrowser_construct_form($tree,$profile);
  $output = drupal_get_form($context,$form);
  return theme('filebrowser', $output);

}

/**
 * Separate the request from the function.
 * Custom filebrowsers can be invoked from any path on the server, and their
 * relative subfolders are tacked onto the end of the URL.
 * 
 *    [admin/custom/filebrowser/][my/special/files]
 * 
 * Find where to split this request. Use rexeps, as strrpos is broken
 * @return the base filebrowser path for the current job. Contains trailing
 * slash.
 */
function filebrowser_split_base($subfolder){
  $filebrowser_base = preg_replace('|'.preg_quote($subfolder).'$|','',$_GET['q']);
  return $filebrowser_base;
}


/**
 * Prepend the filebrowser location to the path.
 * Allows  easy path generation even if $path has a leading slash.
 * @param $path
 */
function filebrowser_url($path) {
  static $base; 
  if(!$base){
    $profile = filebrowser_profile();
    $base = $profile['path'];
  }
  return join_paths($base,$path);
}
/**
 * Similar to above, but links directly to the file, 
 * 
 */
function filebrowser_file_url($path) {
  static $rel_url; 
  if(!$rel_url){
    $profile = filebrowser_profile();
    $rel_url = $profile['rel_url'];
  }

  // The rel_url parameter used here may resolve some embedded variables.
  $variables = array(
    '%files' => file_directory_path(),
  );
  $url = join_paths( t( $rel_url ,$variables) ,$path);

  if($profile['serve_as_drupal_files']){
    return file_create_url($url);
  }
  return $url;
}

/**
 * Returns not an l() link, but an AJAX trigger tha has a similar effect.
 */
function filebrowser_inline_link($title,$path){
  $uri = url(filebrowser_url($path) , 'mode=in-place');
  return l($title, '#', array('onClick' => "HTTPGet(\"$uri\", display_subdirectory, \"filebrowser\");return false;") );
}

/**
 * Add the appropriate prefixes to a path 
 * to return a complete system path. 
 * 
 * May manipulate the input path by reference to find a parent if the target
 * does not exist.
 */
function filebrowser_create_path(&$path,$profile=array()){
  filebrowser_set_profile_defaults($profile);

  if(substr($path,0,strlen($profile['root'])) == $profile['root'])
    $completepath = $path;
  else 
    // If path is not already under root, prepend it
    $completepath = join_paths($profile['root'],$path);

  if($profile['serve_as_drupal_files']){
    $completepath=file_create_path($completepath);
  }

  if (! is_dir($completepath)) {
    drupal_set_message("$completepath wasn't found to be a directory. Going up");
    $completepath = dirname($completepath);
    $path = dirname($path);
  }
  return $completepath;
}

/**
 * Implimentation of hook_file_download
 * Need to let the system/files 'private' method know it can let everything
 * through.
 * This is hence less secure than the 'private' restriction used to be.
 */
function filebrowser_extensions_file_download($file) { 
  if (TRUE || user_access('access content')) { 
    # If it exists, and you can see it, you can get it.
    $file = file_create_path($file);
    $name = mime_header_encode($file->filename);
    return array(
          'Content-type: '. mime_content_type ($file),
    );
  } 
  else { 
    return -1; 
  } 
} 

/**
 * The breadcrumbs will be set relative to the current filebrowser profile root.
 * 
 * When mode is set to 'in-place', the links will trigger an AJAX refresh rather
 * than a page load.
 */
function filebrowser_set_breadcrumbs($subfolder){
  $parts=split('/',$subfolder);

  $breadcrumb = array();
  $profile = filebrowser_profile();

  if ($parts) {
    $breadcrumb[] = array_pop($parts);
    while (count($parts)) {
      if($profile['render'] == 'popup'){
        $breadcrumb[] = filebrowser_inline_link($parts[count($parts) -1], join("/", $parts)); 
      } else {
        $breadcrumb[] = l($parts[count($parts) -1], filebrowser_url(join("/", $parts)));
      }
      array_pop($parts);
    }
    $breadcrumb[] = l(t('top'), filebrowser_url(''));
  } else {
    $breadcrumb[] = t('Filebrowser');
  }
  $breadcrumb[] = l(t('Home'), NULL);
  drupal_set_breadcrumb(array_reverse($breadcrumb));
}

/**
 * Return a themed breadcrumb trail.
 * 
 * Only difference is the divider is a slash.
 * @see theme_filebrowser_breadcrumb()
 */
function theme_filebrowser_breadcrumb($breadcrumb) {
  if (!empty($breadcrumb)) {
    return '<div class="breadcrumb">'. implode(' / ', $breadcrumb) .'</div>';
  }
}


/**
 * Display a filebrower window as a pop-up
 * 
 * The filebrowser_popup path is added to the menu. 
 * 
 * Javascript callbacks.
 * If this page is called with a $_GET['targetelement']
 * parameter, the opener page that called this popup will have the value of the
 * named form element set. If called with a $_GET ['callback'] parameter, the
 * named function will be called in the opener window, with the selected
 * filename as a parameter.
 * 
 * 
        '#type'        => 'button',
        '#value'       => 'Browse Server...', 
        '#attributes'  => array( "onclick" => 
          "window.open('"
            . url("filebrowser_popup/", NULL, NULL, true)
            . "'+document.getElementById ('edit-choose_file')
            . value+'?targetelement=edit-choose_file&subsection="
            . file_directory_path()
            . "/'
          ,'filebrowser'
          ,'width=300, height=400, resizable=yes, scrollbars=yes');
          return false;",
         ),
       );
 *
 * The targetelement parameter sent to the popup is the id of the element the
 * result should be sent to once the user selects something. The subsection
 * parameter should be trimmed off the front of it if neccessary.
 *
 * The subsection to start from should be passed in either as part of the path,
 * or via $_REQUEST['subsection']. 
 * Authentication for access to these areas is made as usual via the
 * profiles configs. 
 *
 */


/**
 * Theme a filebrowser block, as a list or table.
 */
function theme_filebrowser(&$output) {
  if(module_exist('tweakui')){
    // UI enhancements - select tree and mouseover rows.
    tweakui_javascript_functions();
    tweakui_css();
  }

  // Add the filebrowser CSS to the page
  theme_add_style(drupal_get_path('module','filebrowser_extensions') .'/filebrowser-tree.css');

  return '<div class="filebrowser">' . $output . '</div>';
}


///////////////////////////////////////////////////////////////////////////////


/**
 * From a flat list of file defs, build a tree structure, and annotate it like
 * the forms API does.
 * 
 * The file defs are expected to be supplying complete system paths,
 * so this must be trimmed back before working with them.
 * The file['filepath'] values are returned after being made relative to the
 * $base. (base is removed)
 * 
 * Incidentally creates a parent trail showing the higher folders if the profile
 * show_uplinks is true.
 * 
 * @param $dir_structure A flat array of file details
 * @base the part of the path that needs to be trimmed off to make the working
 * path relative again - to whatever
 * @param $subfolder where, underneath filebrowser_root, we are viewing. It has
 * no trailing slash
 */
function filebrowser_sort_list_into_tree($dir_structure,$base='',$subfolder=''){
  $subfolder = trim($subfolder,'/'); 
  $base = $base?$base:file_directory_path();
  $profile = filebrowser_profile();

  $rel_base = trim(substr($dir_structure[0]->filename,strlen($base)),'/');
  #dsm($dir_structure);
  $tree = array ();
  $count = 0;
  foreach ($dir_structure as $file_path => $file_info) {
    $filename = $file_info->filename;
    if(substr($filename,0,strlen($base)) == $base){
      $rel_path = trim(substr($filename,strlen($base)),'/');
    } 
    else{
      drupal_set_message($filename ." not inside $base. This shouldn't be. Illegal paths in config?",'error');
    }

    if(($profile['hide_directories']) && is_dir($filename)){
      continue;
    }

    // rel_path is rel to the file storage dir, 
    // $local_path is the current file relative to the current context
    // When listing the contents of /profile_root/local_path
    // you have permission to browse up to /profile_root, but no further
    // rel_path = subfolder+local_path
    // filename = storage+relpath = storage+subfolder+local_path
    $local_path = trim(substr($rel_path,strlen($subfolder)),'/');

    # dsm("rel_path $rel_path minus subfolder $subfolder equals localpath $local_path");

    $ancestors = split("/", $local_path);
    
    $twig = & $tree; // find the current twig, starting from the top
    $path = $rel_base;

    // Add parent special case as if it were a child
    if($file_path == '..'){$ancestors = array('..');}

    while ($dad = array_shift($ancestors)) {
      // walk down the path
      if (!array_key_exists($dad, $twig)) {
        // add new branch
        $twig['#type']     = 'disk_folder';
        $twig['#rel_path'] = $path?join_paths($subfolder,$path):'.';
        $twig['#title']    = $path?basename($path):'top';
        $twig['#filename'] = join_paths($base,join_paths($subfolder,$path)); 
        $twig[$dad] = array();
        $count++;
      }
      $path .= $dad.'/';
      $twig = & $twig[$dad];
    }
    $twig['#type']       = (is_dir($file_path))?'disk_folder':'disk_file';
    $twig['#title']      = $file_info->basename;
    $twig['#filename']   = $filename; 
    $twig['#rel_path']   = $rel_path;

  }
  # dsm($tree);
  return $tree;  
}

/**
 * Given a tree structure full of file definitions, massage the structure into
 * nested tables (to be rendered later). Pretty intensive rebuild.
 * 
 * This is a step between looking at the file structure as an API form, and
 * using the API form builder to construct tables for me (using the formtable
 * extension). It treats form elements and table builder elements as similar
 * things. Just requires a bit of care translating between #properties and form
 * builder 'data'
 */
function filebrowser_tree_to_tables($tree,$cols = array('icon','name','size') ){
  
  if(! function_exists('formtable_elements')){
    drupal_set_message(t("Cannot render the filebrowser files as a table without the formtable extension"),'error');
    filebrowser_extensions_install();
  }
  $table = array(
    '#type' => 'formtable' , 
    '#attributes'=>array(
      'class' => 'filebrowser_table groupItem', 
      'id'    => filebrowser_id($tree['#filename']).'_content')
  );
  # dsm($tree);

  if($tree['..']){ // special case. Asked to show parent, render it first
    $table['..'] = array(
      '#type' => 'tr',
      'link' => array(
        '#type' => 'td',
        '#attributes' => array('colspan'=>'3'),
        '#value' => l($tree['..']['#title'],filebrowser_url($tree['..']['#rel_path'])),
      )
    );
    unset($tree['..']);
  }
  
  static $count; // for odd-even

  foreach(element_children($tree) as $twig_key){
    $twig = $tree[$twig_key];
      
    if(!is_array($twig))$twig = array('#filename' => $twig_key);
    $row = array( '#type' => 'tr' ); 

    // populate the columns
    $weight = 0; // keep in order
    foreach($cols as $colname){
      $func = 'filebrowser_get_cell_'.$colname;
      if(function_exists($func)){
        $cell = $func($twig['#filename'],$twig);
        // read content out of cell, 
        // need to adjust it slightly to live within form struct, not table struct
        if(is_array($cell)){
          $row[$colname]['#value'] = $cell['data'];
          unset($cell['data']);
          unset($cell['sv']);
          $row[$colname]['#attributes'] = $cell;
          $row[$colname]['#attributes']['class'] .= ' '.$colname;
        } 
        else {
          $row[$colname]['#value'] = print_r($cell,1);
        }
        $row[$colname]['#type'] = 'td';
        $row[$colname]['#weight'] = $weight++;
      }
    }
    $row['#attributes']['class'] = ($count++ % 2 == 1) ? 'even': 'odd';

    $table[$twig_key] = $row;
    if(element_children($twig)){
      // todo test recursion again

      // It's a container, insert its children in a row/cell below
      $table[$twig_key]['#attributes']['class'] .= ' container';
      // This is imperfect nesting, but will have to do.
      // one day I'll imagine a LI schema for this. I considered tbody - but I can't nest them
      $row = array(
        '#type' => 'tr',
      ); 
      $row[] = array('#type' => 'td');  //indent
      $row[] = array(
        '#type' => 'td' , 
        '#attributes'=>array('colspan'=>count($cols)-1,'class'=>'contents'), 'data' => filebrowser_tree_to_tables($twig,$cols)
      );

      $table[$twig_key.'contents'] = $row;
    } 
  }
  #dsm($table);
  return $table;
}


/**
 * Layout a directory listing using only css, no table.
 * 
 * Construct the elements mostly as if they were form elements
 */
function filebrowser_tree_to_rows($tree,$cols = array('icon','name','size')){
  $table = array(
    '#type' => 'markup' ,
    '#prefix' => "\n\n<ul class='filebrowser_list' id='".filebrowser_id($tree['#rel_path'])."_content'>" , 
    '#suffix' => "</ul>\n" , 
  );

  if($tree['..']){ // special case. Asked to show parent, render it first
    $table['..'] = filebrowser_item_row($tree['..'], array('icon','name') );
    unset($tree['..']);
  }
  
  foreach(element_children($tree) as $twig_key){
    $twig = $tree[$twig_key];
    if(!is_array($twig))$twig = array('#filename' => $twig_key);

    $row = filebrowser_item_row($twig,$cols);
    if(element_children($twig)){
      $row['value'] = filebrowser_tree_to_rows($twig,$cols);
      // As the columns are ordered, need to ensure the nested content comes after them
      $row['value']['#weight'] = count($cols) +1;
    } 
    $table[$twig_key] = $row;
  }
  return $table;
}

/**
 * Structure list item elements representing a files info
 * 
 * This is the central build call-back engine that invokes the cell renderers
 */
function filebrowser_item_row($twig,$cols){
  static $count; // as well as odd-even, we also need weight for ordering, as form_render seems to sort arbitrarily if I don't define it.'
  $count ++;
  $class = ($count % 2 == 1) ? 'even': 'odd';
  $class .=  ($twig['#type']=='disk_folder')?' container':'';

  $row = array( 
    '#type' => 'markup' , 
    '#weight' => $count,
    '#prefix' => "\n".'<li class="'.$class.'" id="checkbox_'.filebrowser_id($twig['#rel_path']).'">',
    '#suffix' => '</li>' ,
  ); 

    $row['properties'] = array(
#      '#prefix' =>  "<div class=' properties ' >",
#      '#suffix' => "</div> " 
       '#suffix' => "<br/> " 
    );

  // populate the columns/elements
  $o = 1;
  foreach($cols as $colname){
    $element = array(
      '#type' => 'markup' ,
      '#weight' => $o++,
    );
    $func = 'filebrowser_get_cell_'.$colname;

    if(function_exists($func)){
      // It's a toss-up which is mostly more useful, the absolute or rel path
      // Both are available
      $cell = $func($twig['#filename'],$twig);

      // read content out of cell, 
      // need to adjust it slightly to live within form struct, not table struct
      if(is_array($cell)){
        $element['#value'] = $cell['data'];
        unset($cell['data']);
        $element['#attributes'] = $cell;
      } 
      else {
        // just returned a string
        $element['#value'] = print_r($cell,1);
      }
    }
    $class = $element['#attributes']['class'].' '.$colname ;
    $id = $cell['id'] ? "id='".$cell['id']."'" : "";
    $element['#prefix'] = " <span class=' $class ' $id >" ; 
    $element['#suffix'] = "</span> " ;
    $row['properties'][$colname] = $element;
  }
  return $row;
}


///////////////////////////////////////////////////////////////////////////////
// Autocomplete

/**
 * Helper function for autocompletion
 * Returns files or directories matching the given pattern
 */
function filebrowser_autocomplete() {
  $parts = func_get_args();
  return filebrowser_do_autocomplete($parts); 
}
/**
 * Helper function for autocompletion
 * Returns directories matching the given pattern
 */
function filebrowser_autocomplete_directory() {
  $parts = func_get_args();
  return filebrowser_do_autocomplete($parts,GLOB_ONLYDIR); 
}

/**
 * Return the JS response listing the contents of the requested directory.
 * Security should have happened before now.
 * Uses glob patterns configured in the profile.
 */
function filebrowser_do_autocomplete($parts='',$globflag=0) {
  $context = array_shift($parts);

  $path = join('/',$parts);
  $profile = filebrowser_profile($context);

//  if(!$profile['root'])$profile['root']='.';
  $completepath = join_paths($profile['root'],$path);
  if($profile['serve_as_drupal_files']){
    $completepath=file_create_path($completepath?$completepath:'.');
    $chop = file_create_path($profile['root']);
  }

  if(is_dir($completepath) ){
    $folder = $completepath;
    $partial = '';
  } 
  else {
    $partial = basename($completepath);
    $folder = dirname($completepath);
  }
  if(!$folder){$folder='.';}
  $matches = array();
  if (!(is_dir($folder) && ($dir = opendir($folder)))) {
    $matches = array("error - $folder");
  } else {
    foreach (glob("$folder/$partial*" , $globflag) as $filepath) {
      // glob returns the full path, chop the files dir off it again
      if(empty($chop))$path = $filepath;
      else $path = substr($filepath, strlen($chop)+1);
      $matches[$path] = $path;
    }
  }

  if(!$matches){
    $matches = array(''=>t( "No %types matching '%partial' in '%folder'  glob('%glob')" , array('%types' => ($globflag?'directories':'files'), '%partial' => $partial, '%folder' => $folder, '%glob' => "$folder/$partial*" )));
  }
  print drupal_to_js($matches);
  exit();
}

/////////////////////////////////


/**
 * Safely concatenate two paths ensuring they have just 1 slash between, if
 * needed. No leading or trailing slashes
 */
function join_paths($a,$b){
  return trim(join('/',array(trim($a,'/'),trim($b,'/'))),'/');
}

/**
 * Returns a CSS-safe ID generated from the given string
 */
function filebrowser_id($path){
  return "ID_" . preg_replace("/[^\w]/", "", $path);
} 

/**
 * Ensure dependancies exist.
 * Attempt to bootstrap it if not.
 */
function filebrowser_extensions_install(){
  if(! module_exist('formtable')){
    db_query("UPDATE {system} SET status = 1 WHERE type = 'module' AND name = '%s'", 'formtable');
    $contrib = dirname(__FILE__).'/contrib/';
    if(file_exists($contrib.'formtable.dist') && is_writable($contrib) ){
      copy($contrib.'formtable.dist',$contrib.'formtable.module');
      db_query("UPDATE {system} SET status = 1 WHERE type = 'module' AND name = '%s'", 'formtable');
      module_invoke('formtable', 'install');
    } 
    else {
      drupal_set_message("Some formatting options for filebrowser will be unavailable, as the formtable.module layout library is not present. Could not even create it in $contrib.  See the README",'error'); 
    }
  }
}