filedepot.admin.inc in filedepot 6

filedepot.admin.inc Drupal API functions for the Module Admin Settings

File

filedepot.admin.inc

<?php

/**
 * @file
 * filedepot.admin.inc
 * Drupal API functions for the Module Admin Settings
 */
function filedepot_admin_settings() {
  $form['basic'] = array(
    '#type' => 'fieldset',
    '#title' => t('Base Setup'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['basic']['filedepot_storage_path'] = array(
    '#type' => 'textfield',
    '#title' => t('Secure Storage Root Directory'),
    '#description' => t('Full Path to where Filedepot will be saving the folders and files.<br />Should be outside your sites public folder for security but must end in a /'),
    '#default_value' => variable_get('filedepot_storage_path', str_replace('\\', '/', getcwd()) . '/filedepot_private/'),
    '#size' => 60,
  );
  $form['basic']['filedepot_yui_baseurl'] = array(
    '#type' => 'textfield',
    '#title' => t('Base URL to load YUI Javascript Libraries'),
    '#description' => t('Valid URL to load libraries - can be a local location or hosted CDN like Yahoo and Google.<br />Site URL needs to end in a /'),
    '#default_value' => variable_get('filedepot_yui_baseurl', 'http://yui.yahooapis.com/2.7.0/build/'),
    '#size' => 60,
  );
  $form['basic']['filedepot_allow_folder_duplicates'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow Duplicates in Folders'),
    '#default_value' => variable_get('filedepot_allow_folder_duplicates', 1),
    '#description' => t('If enabled, users can upload files with the same name in folders.'),
  );
  $form['performance'] = array(
    '#type' => 'fieldset',
    '#title' => t('Performance Settings'),
    '#description' => t('With very large document repositories, the file listing logic can be optimized by tuning these options for the 3 pass logic.') . t('On initial pass, display a smaller number of files like 2 while all the folders are being generated.') . t('Once the initial folder listing is generated, the 2nd pass will execute in the background and populate all folders with more files up the the number set for the pass 2 setting.') . t('If there are more files in a folder then the pass 2 setting, the user will have a link to return rest (pass 3). This is so a folder with 1000 files does not hang up the application initial view if this folder is not even expanded.') . '<br />' . t('For smaller repositories, you can set Pass 1 to 50 and Pass 2 to 100 for example.'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['performance']['filedepot_pass1_recordcount'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of folder records to initially show in pass1'),
    '#description' => t('While displaying the folder, initially return this number of records.'),
    '#default_value' => variable_get('filedepot_pass1_recordcount', 2),
    '#size' => 5,
  );
  $form['performance']['filedepot_pass2_recordcount'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of folder records to display in background during pass2'),
    '#description' => t('After initially displaying folder structure and files from pass1, background AJAX requests will populate display with more records.'),
    '#default_value' => variable_get('filedepot_pass2_recordcount', 10),
    '#size' => 5,
  );
  $form['notifications'] = array(
    '#type' => 'fieldset',
    '#title' => t('Notification Defaults'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['notifications']['filedepot_notifications_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Notifications Enabled'),
    '#default_value' => variable_get('filedepot_notifications_enabled', 1),
    '#description' => t('If enabled, email notifications for new files added or changed will be sent out.'),
  );
  $form['notifications']['filedepot_default_allow_broadcasts'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow Admin Broadcasts'),
    '#default_value' => variable_get('filedepot_default_allow_broadcasts', 1),
    '#description' => t('If enabled, members with filedepot admin permission will be able to send out broadcast notifications for a file.'),
  );
  $form['notifications']['filedepot_default_notify_newfile'] = array(
    '#type' => 'checkbox',
    '#title' => t('New Files'),
    '#default_value' => variable_get('filedepot_default_notify_newfile', 0),
    '#description' => t('If enabled, users with view access to a folder will be notified of new files being added.'),
  );
  $form['notifications']['filedepot_default_notify_filechange'] = array(
    '#type' => 'checkbox',
    '#title' => t('File Changes'),
    '#default_value' => variable_get('filedepot_default_notify_filechange', 0),
    '#description' => t('If enabled, users with view access to a folder will be notified of new file versions being added.'),
  );
  $form['options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Misc Options'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['options']['filedepot_locked_file_download_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow files to be downloaded if locked'),
    '#default_value' => variable_get('filedepot_locked_file_download_enabled', 1),
    '#description' => t('If enabled, users will be able to download a file when locked.'),
  );
  $form['options']['filedepot_show_index_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Display the index numbers in the listing of folders and files'),
    '#default_value' => variable_get('filedepot_show_index_enabled', 1),
    '#description' => t('If enabled, the display will show the index numbers before folder and file names.'),
  );
  $form['filetype_filter'] = array(
    '#type' => 'fieldset',
    '#title' => t('File Type Filtering and Extension Mapping'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['filetype_filter']['filedepot_filter_mode'] = array(
    '#type' => 'radios',
    '#title' => t('Use inclusion or exclusion mode'),
    '#default_value' => variable_get('filedepot_filter_mode', 1),
    '#options' => array(
      '0' => t('Exclude'),
      '1' => t('Include'),
    ),
    '#description' => t('Choose the way Filedepot will filter for allowable file types during upload.<br />Use exclude to allow all but selected extension:mimetypes. Use include if you want to define each file type to allow and all others will be rejected.'),
  );
  $default_filter = 'jpg,doc,docx,xls,xlsx : application/octet-stream' . "\n";
  $default_filter .= 'xls,xlsx: application/vnd.ms-excel' . "\n";
  $default_filter .= 'doc: application/msword' . "\n";
  $default_filter .= 'jpg: image/jpg' . "\n";
  $form['filetype_filter']['filedepot_filetype_filter'] = array(
    '#type' => 'textarea',
    '#title' => t('File types to exclude/include'),
    '#cols' => 60,
    '#rows' => 5,
    '#prefix' => '<div style="margin-left:20px">',
    '#suffix' => '</div>',
    '#default_value' => variable_get('filedepot_filetype_filter', $default_filter),
    '#description' => t('Enter the file extension or list of extension comma seperated and then : followed by the allowable mime type for that extension(s). ') . '<strong>' . t('Only one entry per line.') . '</strong>',
    '#wysiwyg' => FALSE,
  );
  $default_extension_mapping = 'jpg=jpg.gif, gif=gif.gif, bmp=bmp.gif, doc=doc.gif, docx=doc.gif, xls=xls.gif, xlsx=xls.gif' . "\n";
  $default_extension_mapping .= 'ppt=ppt.gif, pptx=ppt.gif, mpp=mpp.gif, pdf=pdf.gif, txt=txt.gif, zip=zip.gif' . "\n";
  $form['filetype_filter']['filedepot_extensions'] = array(
    '#type' => 'textarea',
    '#title' => t('Extension Mapping'),
    '#cols' => 60,
    '#rows' => 3,
    '#default_value' => variable_get('filedepot_extensions', $default_extension_mapping),
    '#description' => t('This is a comma sepearated list of file type to icon image files. This is used in the filelisting logic to associate an icon to file type uploaded. We don\'t want to assume that all icons will be in gif format.'),
    '#wysiwyg' => FALSE,
  );
  $form['permissions'] = array(
    '#type' => 'fieldset',
    '#title' => t('Default Permissions'),
    '#description' => t('Folders may have sub-folders which have more restrictive or different permissions. Permissions can be assigned by user and/or by role.') . '<br />' . t('Available Permissions are:') . '<ul>' . '<li><strong>' . t('view') . '</strong>: ' . t('Able to view the folder and files within. If you can view the files, you can download them.') . '</li>' . '<li><strong>' . t('admin') . '</strong>: ' . t('Full admin permissions to folder and files within folder. Able to change folder permissions.') . '</li>' . '</li>' . '<li><strong>' . t('upload_dir') . '</strong>: ' . t('Able to upload files directly to folder with no moderation.') . '</li>' . '</li>' . '<li><strong>' . t('upload') . '</strong>: ' . t('Able to upload files but they will need to be approved before appearing in folder listing.') . '</li>' . '</li>' . '<li><strong>' . t('upload_ver') . '</strong>: ' . t('Able to upload new versions to existing files listed in the folder.') . '</li>' . '</li>' . '<li><strong>' . t('approval') . '</strong>: ' . t('Able to moderate (approve or reject) new file submissions.') . '</li>' . '</ul>',
    //li, admin, upload, upload_dir, upload_ver, approval'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['permissions']['filedepot_default_owner'] = array(
    '#type' => 'textarea',
    '#title' => t('Default Owner Permissions'),
    '#cols' => 60,
    '#rows' => 1,
    '#default_value' => variable_get('filedepot_default_owner', 'view, admin, upload_dir, upload_ver, approval'),
    '#description' => t('When a site member creates a new folder, list the default user based permissions the folder should be setup with.'),
    '#wysiwyg' => FALSE,
  );
  $form['permissions']['filedepot_default_roles'] = array(
    '#type' => 'textarea',
    '#title' => t('Default Role Permissions'),
    '#cols' => 60,
    '#rows' => 3,
    '#default_value' => variable_get('filedepot_default_roles', 'authenticated user: view, upload'),
    '#description' => t('Default role based permissions the folder should be setup with. Enter additional mappings of roles to permissions on new lines'),
    '#wysiwyg' => FALSE,
  );
  return system_settings_form($form);
}
function filedepot_admin_settings_validate($form, $form_state) {
  $filterdata = array();
  $rawfilefilter = $form_state['values']['filedepot_filetype_filter'];
  $filterlines = preg_split('/\\r\\n|\\r|\\n/', $rawfilefilter);
  foreach ($filterlines as $line) {
    if (!empty($line)) {
      $data = explode(':', $line);
      $data[0] = trim($data[0]);

      // list of extensions
      $data[1] = trim($data[1]);

      // mimetype
      $extensions = explode(',', $data[0]);
      $filterdata[$data[1]] = $extensions;
    }
  }
  variable_set('filedepot_filetype_filterdata', serialize($filterdata));
  $extensiondata = array();
  $rawextensions = $form_state['values']['filedepot_extensions'];
  $extensionlines = preg_split('/\\r\\n|\\r|\\n/', $rawextensions);
  foreach ($extensionlines as $line) {
    if (!empty($line)) {
      $records = explode(',', $line);
      foreach ($records as $mapping) {
        $data = explode('=', $mapping);
        $ext = trim($data[0]);
        $icon = trim($data[1]);
        $extensiondata[$ext] = $icon;
      }
    }
  }
  variable_set('filedepot_extension_data', serialize($extensiondata));

  /* Parse the default perms settings and create a single associative array the filedepot class will use */
  $validperms = array(
    'view',
    'admin',
    'upload',
    'upload_dir',
    'upload_ver',
    'approval',
  );
  $defaultperms = array();
  $cleanperms = array();
  $ownerperms = $form_state['values']['filedepot_default_owner'];
  $aperms = explode(',', $ownerperms);
  foreach ($aperms as $perm) {
    $perm = trim($perm);
    if (in_array($perm, $validperms)) {
      $cleanperms[] = $perm;
    }
  }
  $defaultperms['owner'] = $cleanperms;
  $rawroleperms = $form_state['values']['filedepot_default_roles'];
  $permlines = preg_split('/\\r\\n|\\r|\\n/', $rawroleperms);
  foreach ($permlines as $line) {
    if (!empty($line)) {
      $parts = explode(':', $line);
      $role = trim($parts[0]);
      $perms = explode(',', $parts[1]);
      foreach ($perms as $perm) {
        $perm = trim($perm);
        if (in_array($perm, $validperms)) {
          $defaultperms[$role][] = trim($perm);
        }
      }
    }
  }
  variable_set('filedepot_default_perms_data', serialize($defaultperms));
}

Functions

Name	Description
filedepot_admin_settings	@file filedepot.admin.inc Drupal API functions for the Module Admin Settings
filedepot_admin_settings_validate