PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of FileStore.php

This file supplies a Memcached store backend for OpenID servers and consumers. PHP versions 4 and 5

Author:	JanRain, Inc. <openid@janrain.com>
Copyright:	2005-2008 Janrain, Inc.
License:	http://www.apache.org/licenses/LICENSE-2.0 Apache
File Size:	621 lines (18 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Auth_OpenID_FileStore:: (22 methods):
  Auth_OpenID_FileStore()
  destroy()
  _setup()
  _mktemp()
  cleanupNonces()
  getAssociationFilename()
  storeAssociation()
  getAssociation()
  _getAssociation()
  removeAssociation()
  useNonce()
  _allAssocs()
  clean()
  _rmtree()
  _mkstemp()
  _mkdtemp()
  _listdir()
  _isFilenameSafe()
  _safe64()
  _filenameEscape()
  _removeIfPresent()
  cleanupAssociations()

Class: Auth_OpenID_FileStore - X-Ref

This is a filesystem-based store for OpenID associations and
nonces. This store should be safe for use in concurrent systems on
both windows and unix (excluding NFS filesystems). There are a
couple race conditions in the system, but those failure cases have
been set up in such a way that the worst-case behavior is someone
having to try to log in a second time.

Most of the methods of this class are implementation details.
People wishing to just use this store need only pay attention to
the constructor.

Auth_OpenID_FileStore($directory) X-Ref

Initializes a new {@link Auth_OpenID_FileStore}. This
initializes the nonce and association directories, which are
subdirectories of the directory passed in.

param: string $directory This is the directory to put the store

destroy() X-Ref

No description

_setup() X-Ref

Make sure that the directories in which we store our data
exist.

_mktemp() X-Ref

Create a temporary file on the same filesystem as
$this->association_dir.

The temporary directory should not be cleaned if there are any
processes using the store. If there is no active process using
the store, it is safe to remove all of the files in the
temporary directory.

return: array ($fd, $filename)

cleanupNonces() X-Ref

No description

getAssociationFilename($server_url, $handle) X-Ref

Create a unique filename for a given server url and
handle. This implementation does not assume anything about the
format of the handle. The filename that is returned will
contain the domain name from the server URL for ease of human
inspection of the data directory.

return: string $filename

storeAssociation($server_url, $association) X-Ref

Store an association in the association directory.

getAssociation($server_url, $handle = null) X-Ref

Retrieve an association. If no handle is specified, return the
association with the most recent issue time.

return: mixed $association

_getAssociation($filename) X-Ref

removeAssociation($server_url, $handle) X-Ref

Remove an association if it exists. Do nothing if it does not.

return: bool $success

useNonce($server_url, $timestamp, $salt) X-Ref

Return whether this nonce is present. As a side effect, mark it
as no longer present.

return: bool $present

_allAssocs() X-Ref

Remove expired entries from the database. This is potentially
expensive, so only run when it is acceptable to take time.

clean() X-Ref

No description

_rmtree($dir) X-Ref

_mkstemp($dir) X-Ref

_mkdtemp($dir) X-Ref

_listdir($dir) X-Ref

_isFilenameSafe($char) X-Ref

_safe64($str) X-Ref

_filenameEscape($str) X-Ref

_removeIfPresent($filename) X-Ref

Attempt to remove a file, returning whether the file existed at
the time of the call.

return: bool $result True if the file was present, false if not.

cleanupAssociations() X-Ref

No description

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/openid/Auth/OpenID/ -> FileStore.php (summary)

Defines 1 class