Binary files service

Actually, this was way easier than I thought. The code below is for a module called 'file_service.module' which exposes a service that, when passed a node id, passes back an array of base64_encode()'d files:

/**
 * Implementation of hook_service().
 */
function file_service_service() {
  return array(
    array(
      '#method'   => 'file.getFiles',
      '#callback' => 'file_service_get_files',
      '#args'     => array(
        array(
          '#name'         => 'nid',
          '#type'         => 'int',
          '#description'  => t('A node id.'),
        ),
      ),
      '#return'   => 'array',
      '#help'     => t('Returns the files attached to a node.')
    ),
  );
}

 

/**
 * returns an array of base64 encoded files attached to a node
 * 
 * @param $nid
 * integer, node id
 * 
 * @return
 * array of files
 */
function file_service_get_files($nid) {
  $node = node_load($nid);
  if (isset($node->files)) {
    $files = array();
    foreach ($node->files as $file) {
      //rebuild the files array so it only contains files we know we're allowed to list
      if ($file->list) {
        $files[] = $file;
      }
    }
    if (count($files) > 0) {
      $send = array();
      foreach ($files as $file) {
        $file = array_shift($files);
        //this needs cleaning up:
        $filepath = 'c:/path/to/drupal/'.$file->filepath;
        $binaryfile = fopen($filepath, 'rb');
        $send[] = base64_encode(fread($binaryfile, filesize($filepath)));
        fclose($binaryfile);
      }
    }
  }
 
  //don't fail silently if there are no files!
  if (!$send) {
    $send = array();
    $send[] = 'NO FILES';
  }
  
  return $send;
}

There are many additions you could make to this module, but this is all I'll probably do for now. Obviously, you need to base64_decode() the items in the array when you are at the client side. My quick test code on the client looked like this:

$request = xmlrpc_encode_request(
  "file.getFiles", array(
    9
  )
);
 
$context = stream_context_create(
  array(
    'http' => array(
      'method' => "POST",
      'header' => "Content-Type: text/xml",
      'content' => $request
    )
  )
);
 
$file = file_get_contents("http://localhost/services/xmlrpc", false, $context);
 
$response = xmlrpc_decode($file);
if (xmlrpc_is_fault($response)) {
    trigger_error("xmlrpc: $response[faultString] ($response[faultCode])");
} else {
    $newfile = fopen('c:\image.jpg', "wb");
    fwrite($newfile, base64_decode($response[0]));
    fclose($newfile);
    print '<h1>Received</h1><pre>'. htmlspecialchars(print_r($response, true)) .'</pre>';
}

Good point! I'll build one in. =)

EDIT: anyone with an API key - I have API keys on, so I didn't worry about access too much.

New version:

/**
 * Implementation of hook_perm().
 */
function file_service_perm() {
  return array('get binary files');
}

/**
 * Implementation of hook_service().
 */
function file_service_service() {
  return array(
    array(
      '#method'   => 'file.getFiles',
      '#callback' => 'file_service_get_files',
      '#access callback' => 'file_service_get_files_access',
      '#args'     => array(
        array(
          '#name'         => 'nid',
          '#type'         => 'int',
          '#description'  => t('A node id.'),
        ),
      ),
      '#return'   => 'array',
      '#help'     => t('Returns the files attached to a node.')
    ),
  );
}

 

/**
 * returns an array of base64 encoded files attached to a node
 * 
 * @param $nid
 * integer, node id
 * 
 * @return
 * array of files
 */
function file_service_get_files($nid) {
  $node = node_load($nid);
  if (isset($node->files)) {
    $files = array();
    foreach ($node->files as $file) {
      //rebuild the files array so it only contains files we know we're allowed to list
      if ($file->list) {
        $files[] = $file;
      }
    }
    if (count($files) > 0) {
      $send = array();
      foreach ($files as $file) {
        $file = array_shift($files);
        $filepath = variable_get('file_service_fullpath', '/').$file->filepath;
        $binaryfile = fopen($filepath, 'rb');
        $send[$file->fid]['file'] = base64_encode(fread($binaryfile, filesize($filepath)));
        $send[$file->fid]['filename'] = $file->filename;
        $send[$file->fid]['uid'] = $file->uid;
        $send[$file->fid]['filemime'] = $file->filemime;
        $send[$file->fid]['filesize'] = $file->filesize;
        $send[$file->fid]['status'] = $file->status;
        $send[$file->fid]['timestamp'] = $file->timestamp;
        fclose($binaryfile);
      }
    }
  }

  //don't fail silently if there are no files!
  if (!$send) {
    $send = array();
    $send[] = 'NO FILES';
  }
  
  return $send;
}

/**
 * access callback function for the files service
 */
function file_service_get_files_access() {
  return user_access('get binary files');
}

/**
 * admin form for file service
 */
function file_service_admin_form() {
  //define our admin form
  $form = array();
  $form['fullpath'] = array(
    '#title' => t('Path to Drupal installation'),
    '#type' => 'textfield',
    '#required' => 'true',
    '#default_value' => variable_get('file_service_fullpath', '/'),
  );
  $form['submit'] = array(
    '#value' => 'Save settings',
    '#type' => 'submit',
  );
  
  return $form;
}

function file_service_admin_form_submit(&$form, &$form_state) {
  variable_set('file_service_fullpath', $form_state['values']['fullpath']);
  drupal_set_message(t('Settings saved.'));
}

Thanks. Will post my image service too at some point.

I finished it. Just haven't gotten around to posting it and it's at work (and I'm not!) ... I'll try and remember to post it tomorrow. =)

See this new issue: http://drupal.org/node/310155#comment-1017328

Not by me, but it's a very simple module. Assuming the Services API is the same, there would be little difference. But I don't have any Drupal 5 sites to try it on any more, and I won't be creating one especially. Someone who uses Drupal 5 with services will need to pick this up.

Changed the status for you. =)