Development

client library

image
thumbnail
video
userpicture:34:39
Bfjkd34284FDFD43432FDJKLDFjfdmnb
  $ cd; mkdir mfs-trunk; cd mfs-trunk
  $ svn co http://code.sixapart.com/svn/mogilefs/trunk .

$ perl Makefile.PL; make; make test

# cpan
cpan> install Gearman::Client
... and just follow the directions ...

$ VERBOSE=1; export VERBOSE

# apt-get install libc6-dev

$ perl Makefile.PL; make; make test
... and if all tests pass ...
# make install

$ cd ~/mfs-trunk/server
$ perl Makefile.PL; make; make test
# make install

$ cd ~/mfs-trunk/utils
$ perl Makefile.PL; make; make test
# make install

# vi /etc/hosts
127.0.0.1 mfs-db mfs-files

$ cd ~/mfs-trunk/server
$ ./mogdbsetup --dbhost=mfs-db.mydomain.com --dbname=mogilefs --dbuser=mogile --dbpass=mypass --dbrootuser=root --dbrootpass=myrootpass

# adduser mogilefs
# cd /etc; mkdir mogilefs; vi mogilefs/mogilefsd.conf
... and add the following ...
db_dsn DBI:mysql:mogilefs:mfs-db.mydomain.com
db_user mogile
db_pass mypass
conf_port 7001
listener_jobs 5
trackers = 127.0.0.1

# mkdir /var/mogilefs
# vi /etc/mogilefs/mogstored.conf
... and add the following ...
httplisten=0.0.0.0:7500
mgmtlisten=0.0.0.0:7501
docroot=/var/mogilefs

# mogstored --daemon

$ su mogilefs
mogilefs@mydomain:~$ mogilefsd -c /etc/mogilefs/mogilefsd.conf --daemon
mogilefs@mydomain:~$ exit

$ mogadm host add mfs-files --ip=127.0.0.1 --status=alive
$ mogadm device add mfs-files 1
# mkdir /var/mogilefs/dev1

# mkdir /etc/perlbal
# touch /etc/perlbal/perlbal.conf
# touch /etc/perlbal/nodelist.dat
... add the following to perlbal.conf ...
CREATE POOL my_apaches
  # change ip address and port as appropriate
  # remember that Perlbal runs on port 80 and your site runs on another port
  POOL my_apaches ADD 111.222.333.444:8080

CREATE SERVICE balancer
  SET listen             = 111.222.333.444:80
  SET pool               = my_apaches
  SET role               = reverse_proxy
  SET enable_reproxy     = true
  SET persist_client     = on
  SET persist_backend    = on
  SET verify_backend     = on
ENABLE balancer

CREATE POOL dynamic
  SET nodefile = nodelist.dat

... add the following to nodelist.dat ...
111.222.333.444

$ mogadm domain add mydomain
$ mogadm class add mydomain my_file_class

mogadm
$ mogadm

$ php symfony plugin-install http://plugins.symfony-project.com/sfMogileFSPlugin

dev:
  sfMogileFSPlugin:
    domain:     mogilefs_domain
    timeout:    5
    trackers:   [111.111.111.1:7001, 222.222.222.2:7001]

@mfs
  url:   /i/:mkey
  param: { module: file, action: showMogileFSFile }

$mfile = new sfMogileFSFile();
$mfile->setKey($mfs_key);
$mfile->setClass($mfs_class);
$mfile->setFile($local_file);
$mfile->save(); // saves to MogileFS

$mfile = new sfMogileFSFile($key, $class, $file);
$mfile->save();

$mfile = sfMogileFS::loadFile($mfs_key);

$mfile = sfMogileFS::loadFile($mfs_key);
$mfile->getPath();

  files:
    _attributes:       { phpName: File }
    id:
    user_id:           { type: integer, foreignTable: users, foreignReference: id, onDelete: cascade }
    file_type_id:      { type: integer, foreignTable: file_types, foreignReference: id, onDelete: cascade }
    mime_type:                 varchar(128)
    extension:                 varchar(8)
    title:                     varchar(128)
    description:               varchar(255)
    created_at:
    updated_at:

  photos:
    _attributes:            { phpName: Photo }
    id:
    file_id:                { type: integer, foreignTable: files, foreignReference: id, onDelete: cascade }
    photo_type_id:          { type: integer, foreignTable: photo_types, foreignReference: id, onDelete: cascade }
    photo_status_type_id:   { type: integer, foreignTable: photo_status_types, foreignReference: id, onDelete: cascade }
    mogilefs_key:           { type: varchar(40), phpName: MogileFSKey, required: true }
    width:                          integer
    height:                         integer
    filesize:                       integer
    created_at:

class uploadAction extends sfAction
{
  public function execute()
  {
    if ($this->getRequest()->getMethod() == sfRequest::POST && $this->getRequest()->hasFiles())
    {
      if ($this->getRequest()->hasFileErrors())
      {
        $this->setFlash('notice', 'An error occurred while uploading ('.$this->getRequest->getFileError('file').')');
        $this->redirect('@upload');
      }

      // save() method adds file to File and Photo tables as well as MogileFS
      $file = new File();
      $file->setUserId($this->getUser()->getId());
      $file->setFileTypeId(1); // image
      $file->setMimeType($this->getRequest()->getFileType('file'));
      $file->setExtension($this->getRequest()->getFileExtension('file'));
      $file->setTitle($this->getRequestParameter('title'));
      $file->setDescription($this->getRequestParameter('description'));
      $file->setTmpFile($this->getRequest()->getFilePath('file')); // not actually part of model but used by it
      $file->setFilesize($this->getRequest()->getFileSize('file')); // not actually part of the model but used by it
      $file->save();

      // delete upload
      unlink($file->getTmpFile());

      // redirect to upload form
      $this->setFlash('notice', 'Your file has been uploaded');
      $this->redirect('@upload');
    }
    else
    {
      // display upload form
      return sfView::SUCCESS;
    }
  }

class Photo extends BasePhoto
{
  public function save($con = null)
  {
    if ($this->isNew())
    {
      $this->setMogileFSKey(hash('sha1', $this->getFileId().':'.$this->getId()));
    }
    parent::save($con);
  }
}

class File extends BaseFile
{
  protected $filesize;
  protected $tmp_file;

  public function setFilesize($fileSize)
  {
    $this->filesize = $fileSize;
  }

  public function getFilesize()
  {
    return $this->filesize;
  }

  public function setTmpFile($filePath)
  {
    $this->tmp_file = $filePath;
  }

  public function getTmpFile()
  {
    return $this->tmp_file;
  }

  /**
   * save
   * adds original file to file table, sub-file (photo, etc) table and MogileFS
   * All steps are wrapped in a transaction.
   *
   * @param mixed $con
   * @access public
   * @return void
   */
  public function save($con = null)
  {
    if ($this->isNew())
    {
      list($width, $height) = getimagesize($this->getTmpFile());

      // store it
      $con = Propel::getConnection();
      try
      {
        $con->begin();

        // save to File table
        parent::save($con);

        // add to photo table
        if ($this->getFileTypeId() == 1)
        {
          $photo = new Photo();
          $photo->setFileId($this->getId()); // parent file
          $photo->setPhotoTypeId(1); // original photo
          $photo->setPhotoStatusTypeId(1); // uploaded but not converted
          $photo->setWidth($width);
          $photo->setHeight($height);
          $photo->setFilesize($this->getFilesize());
          $photo->save();
        }

        // save to MogileFS
        $sfMogileFSFile = new sfMogileFSFile();
        $sfMogileFSFile->setKey($photo->getMogileFSKey());
        $sfMogileFSFile->setClass('orig_photo');
        $sfMogileFSFile->setFile($this->getTmpFile());
        $sfMogileFSFile->setFilesize($photo->getFilesize());
        $sfMogileFSFile->save();

        $con->commit();
      }
      catch (Exception $e)
      {
        $con->rollback();
        throw $e;
      }
    }
  }
}

mfs:
  url:   /i/:mkey
  param: { module: file, action: showMogileFSFile }

class showMogileFSFileAction extends sfAction
{
  public function execute()
  {
    // remove file's extension
    $mogileFSKey = preg_replace('@\.[\w\d]+$@', '', $this->getRequestParameter('mkey'));

    // get mogilefs key from photo table
    $c = new Criteria();
    $c->add(PhotoPeer::MOGILEFS_KEY, $mogileFSKey);
    $photo = PhotoPeer::doSelectOne($c);

    // load path from mogilefs
    $sfMogileFSRemoteFile = sfMogileFS::loadFile($mogileFSKey);

    // call perlbal's x-reproxy-url and set mime type
    $this->getResponse()->setHttpHeader('Content-type', $photo->getFile()->getMimeType(), true);
    $this->getResponse()->setHttpHeader('X-REPROXY-URL', $sfMogileFSRemoteFile->getPath(), true);

    return sfView::HEADER_ONLY;
  }
}

<?php use_helper('MogileFSAsset') ?>
<?php echo mfs_image_tag('cab9f3c712d04de874dafb0af0a0bf03e303e6e0.jpg') ?>

<img src="/index.php/i/cab9f3c712d04de874dafb0af0a0bf03e303e6e0.jpg" />

# apache.conf file
# /i/fjDFJKEJKjfdjadsdkjfds798234432.jpg => /mogilefs.php?mkey=fjDFJKEJKjfdjadsdkjfds798234432
RewriteRule ^i/([A-Za-z0-9]+)[.A-Za-z0-9]*/?$ mogilefs.php?mkey=$1 [L]

//
// example mogilefs.php, to be placed in your web/ folder
//

require_once('/my/path/to/symfony/lib/config/sfConfig.class.php');
require_once('../plugins/sfMogileFSPlugin/lib/sfMogileFSBaseFile.class.php');
require_once('../plugins/sfMogileFSPlugin/lib/sfMogileFSRemoteFile.class.php');
require_once('../plugins/sfMogileFSPlugin/lib/sfMogileFSConnection.class.php');
require_once('../plugins/sfMogileFSPlugin/lib/sfMogileFS.class.php');

sfConfig::set('app_sfMogileFSPlugin_trackers', array('127.0.0.1:7001'));
sfConfig::set('app_sfMogileFSPlugin_domain', 'my_domain');

$mogileFSKey = preg_replace('@\.[\w\d]+$@', '', $_GET['mkey']);

$link = mysql_connect('127.0.0.1', 'user', 'pass');
mysql_select_db('mydb', $link);

$q = sprintf("select files.mime_type, photos.mogilefs_key from files 
              left join photos on (files.id = photos.file_id) 
              where photos.mogilefs_key='%s'", mysql_real_escape_string($mogileFSKey)
);

$row = mysql_fetch_row(mysql_query($q));

mysql_close($link);

$sfMogileFSRemoteFile = sfMogileFS::loadFile($row[1]);

header("Content-Type: {$row[0]}");
header("X-REPROXY-URL: {$sfMogileFSRemoteFile->getPath()}");

<img src="/i/cab9f3c712d04de874dafb0af0a0bf03e303e6e0.jpg" />

Development

sfMogileFSPlugin

Wiki Navigation

sfMogileFSPlugin

MogileFS Terminology

MogileFS Installation

sfMogileFSPlugin Installation

How It All Works

Interface

Example Setup

Example #1 Displaying a Photo (slower)

Example #2 Displaying a Photo (faster)

Benchmarking Info

MogileFS FAQ

Links

Todo

Changelog

trunk

2007-09-22 | 0.6.0 Beta

2007-07-19 | 0.6.0 Alpha

Active tickets

Attachments

Download in other formats:

	About Installation Documentation Community Blog Development

Development sfMogileFSPlugin
You must first sign up to be able to contribute.