Add php protobuffer support for transition to GTFS-realtime
--- /dev/null
+++ b/.gitignore
@@ -1,1 +1,8 @@
+/labs/tiles/12
+/labs/tiles/13
+/labs/tiles/14
+/labs/tiles/15
+/labs/tiles/16
+/labs/tiles/17
+/labs/tiles/19
--- a/aws/busuiphp.sh
+++ b/aws/busuiphp.sh
@@ -2,9 +2,15 @@
mkdir /var/www/lib/staticmaplite/cache
chcon -h system_u:object_r:httpd_sys_content_t /var/www
chcon -R -h root:object_r:httpd_sys_content_t /var/www/*
+
chcon -R -t httpd_sys_content_rw_t /var/www/lib/staticmaplite/cache
chmod -R 777 /var/www/lib/staticmaplite/cache
+
chcon -R -t httpd_sys_content_rw_t /var/www/labs/tiles
chmod -R 777 /var/www/labs/tiles
+
+chcon -R -t httpd_sys_content_rw_t /var/www/lib/openid-php/oid_store
+chmod -R 777 /var/www/lib/openid-php/oid_store
+
wget http://s3-ap-southeast-1.amazonaws.com/busresources/cbrfeed.zip \
-O /var/www/cbrfeed.zip
--- /dev/null
+++ b/include/common-auth.inc.php
@@ -1,1 +1,91 @@
+<?php
+function getScheme()
+{
+ $scheme = 'http';
+ if (isset($_SERVER['HTTPS']) and $_SERVER['HTTPS'] == 'on') {
+ $scheme .= 's';
+ }
+ return $scheme;
+ }
+function getTrustRoot()
+{
+ return sprintf("%s://%s:%s%s/",
+ getScheme(), $_SERVER['SERVER_NAME'],
+ $_SERVER['SERVER_PORT'],
+ dirname($_SERVER['PHP_SELF']));
+ }
+
+
+// Includes required files
+set_include_path(get_include_path() . PATH_SEPARATOR . $labsPath."lib/openid-php/");
+require_once "Auth/OpenID/Consumer.php";
+require_once "Auth/OpenID/FileStore.php";
+require_once "Auth/OpenID/AX.php";
+
+
+
+function login()
+{
+ // Just tested this with/for Google, needs trying with others ...
+$oid_identifier = 'https://www.google.com/accounts/o8/id';
+ // Create file storage area for OpenID data
+ $store = new Auth_OpenID_FileStore('lib/openid-php/oid_store');
+ // Create OpenID consumer
+ $consumer = new Auth_OpenID_Consumer($store);
+ // Create an authentication request to the OpenID provider
+ $auth = $consumer -> begin($oid_identifier);
+
+ // Create attribute request object
+ // See http://code.google.com/apis/accounts/docs/OpenID.html#Parameters for parameters
+ // Usage: make($type_uri, $count=1, $required=false, $alias=null)
+ $attribute[] = Auth_OpenID_AX_AttrInfo :: make('http://axschema.org/contact/email', 2, 1, 'email');
+ $attribute[] = Auth_OpenID_AX_AttrInfo :: make('http://axschema.org/namePerson/first', 1, 1, 'firstname');
+ $attribute[] = Auth_OpenID_AX_AttrInfo :: make('http://axschema.org/namePerson/last', 1, 1, 'lastname');
+
+ // Create AX fetch request
+ $ax = new Auth_OpenID_AX_FetchRequest;
+
+ // Add attributes to AX fetch request
+ foreach($attribute as $attr) {
+ $ax -> add($attr);
+ }
+
+ // Add AX fetch request to authentication request
+ $auth -> addExtension($ax);
+ $_SESSION['returnURL'] = curPageURL();
+ // Redirect to OpenID provider for authentication
+ $url = $auth -> redirectURL(getTrustRoot(), $_SESSION['returnURL']);
+ header('Location: ' . $url);
+ }
+
+
+function auth()
+
+{
+ if ($_SESSION['authed'] == true) return true;
+
+ // Create file storage area for OpenID data
+ $store = new Auth_OpenID_FileStore('lib/openid-php/oid_store');
+ // Create OpenID consumer
+ $consumer = new Auth_OpenID_Consumer($store);
+ // Create an authentication request to the OpenID provider
+ $response = $consumer -> complete($_SESSION['returnURL']);
+
+ if ($response -> status == Auth_OpenID_SUCCESS) {
+ // Get registration informations
+ $ax = new Auth_OpenID_AX_FetchResponse();
+ $obj = $ax -> fromSuccessResponse($response);
+ $email = $obj -> data['http://axschema.org/contact/email'][0];
+ var_dump($email);
+ if ($email != "maxious@gmail.com") {
+ die("Access Denied");
+ } else {
+ $_SESSION['authed'] = true;
+ }
+ } else {
+ login();
+ }
+ }
+ if ($_REQUEST['janrain_nonce']) auth();
+?>
--- a/include/common-template.inc.php
+++ b/include/common-template.inc.php
@@ -159,8 +159,8 @@
if ($serviceAlertsEnabled) {
$serviceAlerts = getServiceAlerts("network","network");
foreach ($serviceAlerts['entities'] as $entity) {
- echo "<div id='servicewarning'>".date("F j, g:i a",strtotime($entity['alert']['active_period']['start']))." to ". date("F j, g:i a", strtotime($entity['alert']['active_period']['end']))."<br>Warning: {$entity['alert']['description']['translation']}
- <br><a href='{$entity['alert']['url']['translation']}'>Source</a> </div>";
+ echo "<div id='servicewarning'>".date("F j, g:i a",strtotime($entity['alert']['active_period']['start']))." to ". date("F j, g:i a", strtotime($entity['alert']['active_period']['end']))."{$entity['alert']['header_text']['translation']['text']}<br>Warning: {$entity['alert']['description_text']['translation']['text']}
+ <br><a href='{$entity['alert']['url']['translation']['text']}'>Source</a> </div>";
}
}
}
--- a/include/common-transit.inc.php
+++ b/include/common-transit.inc.php
@@ -45,6 +45,55 @@
return "";
}
}
+
+$serviceAlertCause = Array(
+UNKNOWN_CAUSE
+OTHER_CAUSE
+TECHNICAL_PROBLEM
+STRIKE
+DEMONSTRATION
+ACCIDENT
+HOLIDAY
+WEATHER
+MAINTENANCE
+CONSTRUCTION
+POLICE_ACTIVITY
+MEDICAL_EMERGENCY
+
+Unknown cause
+Other cause (not represented by any of these options)
+Technical problem
+Strike
+Demonstration
+Accident
+Holiday
+Weather
+Maintenance
+Construction
+Police activity
+Medical emergency
+);
+$serviceAlertEffect = Array(
+NO_SERVICE
+REDUCED_SERVICE
+SIGNIFICANT_DELAYS
+DETOUR
+ADDITIONAL_SERVICE
+MODIFIED_SERVICE
+OTHER_EFFECT
+UNKNOWN_EFFECT
+STOP_MOVED
+
+No service
+Reduced service
+Significant delays (insignificant delays should only be provided through Trip updates).
+Detour
+Additional service
+Modified service
+Stop moved
+Other effect (not represented by any of these options)
+Unknown effect);
+
function getServiceAlerts($filter_class, $filter_id) {
/*
@@ -66,8 +115,9 @@
route patch: trip remove
*/
$return = Array();
-$return['header']['gtrtfs_version'] = "1";
+$return['header']['gtfs_realtime_version'] = "1";
$return['header']['timestamp'] = time();
+$return['header']['incrementality'] = "FULL_DATASET";
$return['entities'] = Array();
foreach(getCurrentAlerts() as $alert) {
$informedEntities = getInformedAlerts($alert['id'],$_REQUEST['filter_class'],$_REQUEST['filter_id']);
@@ -76,8 +126,12 @@
$entity['id'] = $alert['id'];
$entity['alert']['active_period']['start'] = $alert['start'];
$entity['alert']['active_period']['end'] = $alert['end'];
- $entity['alert']['url']['translation'] = $alert['url'];
- $entity['alert']['description']['translation'] = $alert['description'];
+ $entity['alert']['url']['translation']['text'] = $alert['url'];
+ $entity['alert']['url']['translation']['language'] = 'en';
+ $entity['alert']['header_text']['translation']['text'] = $alert['header'];
+ $entity['alert']['header_text']['translation']['language'] = 'en';
+ $entity['alert']['description_text']['translation']['text'] = $alert['description'];
+ $entity['alert']['description_text']['translation']['language'] = 'en';
foreach ($informedEntities as $informedEntity) {
$informed = Array();
--- a/include/common.inc.php
+++ b/include/common.inc.php
@@ -43,6 +43,7 @@
include_once ("common-request.inc.php");
include_once ("common-session.inc.php");
+include_once ("common-auth.inc.php");
include_once ("common-template.inc.php");
@@ -55,6 +56,7 @@
global $debugOkay;
return in_array($debugReason, $debugOkay, false) && isDebugServer();
}
+
function debug($msg, $debugReason = "other")
{
if (isDebug($debugReason)) echo "\n<!-- " . date(DATE_RFC822) . "\n $msg -->\n";
@@ -187,5 +189,6 @@
}
return implode( $glue, $retVal );
}
+
?>
--- a/include/db/trip-dao.inc.php
+++ b/include/db/trip-dao.inc.php
@@ -215,14 +215,14 @@
}
return $query -> fetchAll();
}
-function viaPoints($tripID, $stop_sequence = "")
+function viaPoints($tripID, $stop_sequence = "", $timing_points_only = true)
{
global $conn;
$query = "SELECT stops.stop_id, stop_name, arrival_time
FROM stop_times join stops on stops.stop_id = stop_times.stop_id
WHERE stop_times.trip_id = :tripID
-" . ($stop_sequence != "" ? " AND stop_sequence > :stop_sequence " : "") . "AND substr(stop_code,1,2) != 'Wj' ORDER BY stop_sequence";
+" . ($stop_sequence != "" ? " AND stop_sequence > :stop_sequence " : "") . ($timing_points_only ? "AND substr(stop_code,1,2) != 'Wj' ": ""). " ORDER BY stop_sequence";
debug($query, "database");
$query = $conn -> prepare($query);
if ($stop_sequence != "") $query -> bindParam(":stop_sequence", $stop_sequence);
--- a/labs/index.php
+++ b/labs/index.php
@@ -1,6 +1,18 @@
<?php
include ('../include/common.inc.php');
-include_header("Busness R&D", "index")
+
+include_header("Busness R&D", "index");
+ if ($_SESSION['authed'] == true) {
+ echo '<ul data-role="listview" data-theme="e" data-groupingtheme="e">
+ <li data-role="list-divider" > Admin Features </li>
+ <li><a href="myway_timeliness_calculate.php"><h3>myway_timeliness_calculate</h3>
+ <p>myway_timeliness_calculate</p></a></li>
+ <li><a href="myway_timeliness_reconcile.php"><h3>myway_timeliness_reconcile</h3>
+ <p>myway_timeliness_reconcile</p></a></li>
+ <li><a href="servicealert_editor.php"><h3>servicealert_editor</h3>
+ <p>servicealert_editor</p></a></li>
+ </ul>';
+ }
?>
<ul data-role="listview" data-theme="e" data-groupingtheme="e">
<li data-role="list-divider" > Experimental Features </li>
--- a/labs/myway_timeliness_reconcile.php
+++ b/labs/myway_timeliness_reconcile.php
@@ -1,5 +1,6 @@
<?php
include ('../include/common.inc.php');
+auth();
foreach ($_REQUEST as $key => $value) {
if (strstr($key, "route") && !strstr($value, "Select")) {
$myway_route = str_replace("route", "", $key);
--- a/labs/servicealert_editor.php
+++ b/labs/servicealert_editor.php
@@ -1,5 +1,6 @@
<?php
include ('../include/common.inc.php');
+auth();
include_header("Service Alert Editor", "serviceAlertEditor");
/**
* Currently support:
@@ -12,9 +13,9 @@
* - trip search by route
*/
if (isset($_REQUEST['saveedit'])) {
-
-if ($_REQUEST['saveedit'] != "") updateServiceAlert($_REQUEST['saveedit'], $_REQUEST['startdate'], $_REQUEST['enddate'], $_REQUEST['description'], $_REQUEST['url']);
-else addServiceAlert($_REQUEST['startdate'], $_REQUEST['enddate'], $_REQUEST['description'], $_REQUEST['url']);
+
+ if ($_REQUEST['saveedit'] != "") updateServiceAlert($_REQUEST['saveedit'], $_REQUEST['startdate'], $_REQUEST['enddate'], $_REQUEST['description'], $_REQUEST['url']);
+ else addServiceAlert($_REQUEST['startdate'], $_REQUEST['enddate'], $_REQUEST['description'], $_REQUEST['url']);
echo "Saved " . $_REQUEST['saveedit'];
die();
}
@@ -44,18 +45,26 @@
foreach (getStopRoutes($_REQUEST['stopid'], $sp) as $route) {
addInformedAlert($_REQUEST['stopsearch'], "route", $route['route_id'], "inform");
echo "Added route inform for" . $_REQUEST['stopsearch'] . ", route" . $route['route_id'] . "<br>\n";
-
-
}
}
die();
}
if ($_REQUEST['routesearch']) {
echo "Informing route<br>\n";
- getRouteTrips();
+ $stops = Array();
echo "Informing trips<br>\n";
- echo "Informing stops<br>\n";
- die();
+ foreach(getRouteTrips() as $trip) {
+ addInformedAlert($_REQUEST['stopsearch'], "trip", $trip['trip_id'], "patch");
+ echo "Added trip patch for" . $_REQUEST['stopsearch'] . ", trip" . $trip['trip_id'] . "<br>\n";
+ viaPoints($tripID, "", false);
+ }
+
+ echo "Informing stops<br>\n";
+ foreach($stops as $stop) {
+ addInformedAlert($_REQUEST['stopsearch'], "stop", $_REQUEST['stopid'], "remove");
+ echo "Added stop remove for" . $_REQUEST['stopsearch'] . ", stop" . $_REQUEST['stopid'] . "<br>\n";
+ }
+ die();
}
if ($_REQUEST['streetsearch']) {
@@ -141,7 +150,7 @@
<form action="<?php echo basename(__FILE__) ;
?>" method="get">
<input type="hidden" name="networkinform" value="<?php echo $_REQUEST['edit'];
- ?>"/>
+ ?>"/>
<input type="submit" value="Add Network Inform"/>
</form>
<form action="<?php echo basename(__FILE__) ;
@@ -151,7 +160,7 @@
<input type="text" name="stopid" />
</div>
<input type="hidden" name="stopsearch" value="<?php echo $_REQUEST['edit'];
- ?>"/>
+ ?>"/>
<input type="submit" value="Stop Search"/>
</form>
<form action="<?php echo basename(__FILE__) ;
@@ -161,7 +170,7 @@
<input type="text" name="street" />
</div>
<input type="hidden" name="streetsearch" value="<?php echo $_REQUEST['edit'];
- ?>"/>
+ ?>"/>
<input type="submit" value="Street Search"/>
</form>
<form action="<?php echo basename(__FILE__) ;
@@ -171,7 +180,7 @@
<input type="text" name="routeid" />
</div>
<input type="hidden" name="routesearch" value="<?php echo $_REQUEST['edit'];
- ?>"/>
+ ?>"/>
<input type="submit" value="Route Search"/>
</form>
<?php
--- /dev/null
+++ b/lib/Protobuf-PHP/LICENSE
@@ -1,1 +1,21 @@
+The MIT License
+Copyright (c) 2011 Iván -DrSlump- Montes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
--- /dev/null
+++ b/lib/Protobuf-PHP/README.md
@@ -1,1 +1,198 @@
+Protobuf for PHP
+================
+Protobuf for PHP is an implementation of Google's Protocol Buffers for the PHP
+language, supporting its binary data serialization and including a `protoc`
+plugin to generate PHP classes from .proto files.
+
+Great effort has been put into generating PHP files that include all sort of type
+hints to aide IDE's with autocompletion. Therefore, it can not only be used to
+communicate with Protocol Buffers services but also as a generation tool for
+_data objects_ no matter what the final serialization is.
+
+For more information see the [included man pages](http://drslump.github.com/Protobuf-PHP/).
+
+
+## Requirements
+
+ - PHP 5.3
+ - Pear's Console_CommandLine (for the protoc wrapper tool)
+ - Google's `protoc` compiler version 2.3 or above
+ - GMP or BC Math extensions ¹
+
+ ¹ Only needed for negative values in `int32`, `int64` or `fixed64` types. See
+ the _known issues_ section.
+
+
+## Features
+
+### Working
+
+ - Standard types (numbers, string, enums, messages, etc)
+ - Pluggable serialization backends (codecs)
+ - Standard Binary
+ - Standard TextFormat ¹
+ - PhpArray
+ - JSON
+ - [ProtoJson](https://github.com/drslump/ProtoJson) (_TagMap_ and _Indexed_ variants)
+ - XML
+ - Protoc compiler plugin to generate the PHP classes
+ - Extensions
+ - Unknown fields
+ - Packed fields
+ - Reflection
+ - Dynamic messages with annotations support
+ - Generates service interfaces
+ - Includes comments from .proto files in the generated files
+ - Pear package for easy installation
+
+¹ Only serialization is supported
+
+### Future
+
+ - Speed optimized code generation mode
+ - Support numbers beyond PHP's native limits
+
+
+
+## Example usage
+
+ $person = new Tutorial\Person();
+ $person->name = 'DrSlump';
+ $person->setId(12);
+
+ $book = new Tutorial\AddressBook();
+ $book->addPerson($person);
+
+ // Use default codec
+ $data = $book->serialize();
+
+ // Use custom codec
+ $codec = new \DrSlump\Protobuf\Codec\Binary();
+ $data = $codec->encode($book);
+ // ... or ...
+ $data = $book->serialize($codec);
+
+
+## Installation
+
+Install with Pear
+
+ pear channel-discover pear.pollinimini.net
+ pear install drslump/Protobuf-beta
+
+You can also get the latest version by checking out a copy of the
+repository in your computer.
+
+
+
+## Known issues
+
+
+### Types
+
+PHP is very weak when dealing with numbers processing. Several work arounds have been applied
+to the standard binary codec to reduce incompatibilities between Protobuf types and PHP ones.
+
+ - Protobuf stores floating point values using the [IEEE 754](http://en.wikipedia.org/wiki/IEEE_754) standard
+ with 64bit words for the `double` and 32bit for the `float` types. PHP supports IEEE 754 natively although
+ the precission is platform dependant, however it typically supports 64bit doubles. It means that
+ if your PHP was compiled with 64bit sized doubles (or greater) you shouldn't have any problem encoding
+ and decoded float and double typed values with Protobuf.
+
+ - Integer values are also [platform dependant in PHP](http://www.php.net/manual/en/language.types.integer.php).
+ The library has been developed and tested against PHP binaries compiled with 64bit integers. The encoding and
+ decoding algorithm should in theory work no matter if PHP uses 32bit or 64bit integers internally, just take
+ into account that with 32bit integers the numbers cannot exceed in any case the `PHP_INT_MAX` value (2147483647).
+
+ While Protobuf supports unsigned integers PHP does not. In fact, numbers above the compiled PHP maximum
+ integer (`PHP_INT_MAX`, 0x7FFFFFFFFFFFFFFF for 64bits) will be automatically casted to doubles, which
+ typically will offer 53bits of decimal precission, allowing to safely work with numbers upto
+ 0x20000000000000 (2^53), even if they are represented in PHP as floats instead of integers. Higher numbers
+ will loose precission or might even return an _infinity_ value, note that the library does not include
+ any checking for these numbers and using them might provoke unexpected behaviour.
+
+ Negative values when encoded as `int32`, `int64` or `fixed64` types require the big integer extensions
+ [GMP](http://www.php.net/gmp) or [BC Math](http://www.php.net/bc) (the later only for 64bit architectures)
+ to be available in your PHP environment. The reason is that when encoding these negative numbers without
+ using _zigzag_ the binary representation uses the most significant bit for the sign, thus the numbers become
+ above the maximum supported values in PHP. The library will check for these conditions and will automatically
+ try to use GMP or BC to process the value.
+
+
+### Strings
+
+The binary codec expects strings to be encoded using UTF-8. PHP does not natively support string encodings,
+PHP's string data type is basically a length delimited stream of bytes, so it's not trivial to include
+automatic encoding conversion into the library encoding and decoding routines. Instead of trying to guess
+or offer a configuration interface for the encoding, the binary codec will process the `string` type just as
+it would process `byte` one, delegating on your application the task of encoding or decoding in the desired
+character set.
+
+### Memory usage
+
+Large messages might be troublesome since the way the library is modelled does not allow to parse or
+serialize messages as a streams, instead the whole operation is performed in memory, which allows for faster
+processing but could consume too much RAM if messages are too large.
+
+
+### Unknown fields
+
+Since wire types are different across different codec's formats, it's not possible to transcode unkwnon
+fields consumed in one codec to another. This means, for example, that when consuming a message using the
+binary codec, if it contains unknown fields, they won't be included when serializing the message using the
+Json codec.
+
+
+## Generating PHP classes
+
+The generation tool is designed to be run as a `protoc` plugin, thus it should
+work with any proto file supported by the official compiler.
+
+ protoc --plugin=protoc-gen-php --php_out=./build tutorial.proto
+
+To make use of non-standard options in your proto files (like `php.namespace`) you'll
+have to import the `php.proto` file included with the library. It's location will
+depend on where you've installed this library.
+
+ protoc -I=./Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos \
+ --plugin=protoc-gen-php --php_out=./build tutorial.proto
+
+In order to make your life easier, the supplied protoc plugin offers an additional
+execution mode, where it acts as a wrapper for the `protoc` invocation. It will
+automatically include the `php.proto` path so that you don't need to worry about it.
+
+ protoc-gen-php -o ./build tutorial.proto
+
+
+## LICENSE:
+
+ The MIT License
+
+ Copyright (c) 2011 Iván -DrSlump- Montes
+
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ 'Software'), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
+
+
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/Rakefile
@@ -1,1 +1,120 @@
+# encoding: utf-8
+namespace :pear do
+ support_files = ['README.md', 'LICENSE', 'protoc-gen-php.php', 'protoc-gen-php.bat']
+ tpl_file = 'package.pear'
+ xml_file = 'library/package.xml'
+
+ desc "Generate package.xml"
+ task :xml => [:clean] do |t, args|
+ unless ENV['version'] then
+ puts 'Version number not given. Use "pear:xml version=1.0"'
+ exit 1
+ end
+
+ # Get template contents
+ text = File.read(tpl_file, :encoding => "UTF-8")
+ # Replace the version, date and time
+ text = text.gsub("{VERSION}", ENV['version'])
+ text = text.gsub('{DATE}', Time.now.strftime('%Y-%m-%d'))
+ text = text.gsub('{TIME}', Time.now.strftime('%H:%M:%S'))
+
+ # Include source files
+ dirs = []
+ Dir.glob('library/**/*.*') do |file|
+ file[0, 'library/'.length] = ''
+ dirs << '<file name="' + file + '" role="php">'
+ dirs << '<tasks:replace from="@package_version@" to="version" type="package-info" />'
+ dirs << '</file>'
+ end
+
+ text = text.gsub('{DIRS}', dirs.join("\n"))
+
+ # Generate a new pear package.xml
+ xml = File.new(xml_file, 'w')
+ xml.syswrite(text);
+ xml.close();
+ end
+
+ desc "Build a release"
+ task :package => ['doc:build', :xml] do
+
+ # Copy supporting files to the package root
+
+ support_files.each do |file|
+ cp file, "library/#{file}"
+ end
+
+ begin
+ sh "pear package -n #{xml_file}"
+ rescue Exception => e
+ puts "Rolling back..."
+ Rake::Task['pear:clean'].execute
+ raise
+ end
+
+ Rake::Task['pear:clean'].execute
+ end
+
+ desc "Clean up"
+ task :clean do
+ puts "Cleaning up..."
+
+ # Remove package.xml
+ rm_f xml_file
+
+ # Remove supporting files
+ support_files.each { |file| rm_f "library/#{file}" }
+ end
+
+end
+
+namespace :doc do
+
+ desc "Generate manual"
+ task :build do
+ version = ENV['version']
+ ENV['RONN_MANUAL'] = "Protobuf-PHP #{version}"
+ ENV['RONN_ORGANIZATION'] = "Ivan -DrSlump- Montes"
+ sh "ronn -w -s toc -r5 --markdown man/*.ronn"
+ end
+
+ desc 'Publish to github pages'
+ task :github => 'doc:build' do
+ require 'git'
+ require 'logger'
+
+ remote = `git remote show origin`
+ .split(%r{\n}) # Ruby 1.9 only has grep() on Array
+ .grep(/Push.*URL/)
+ .first[/git@.*/]
+
+ files = [
+ 'protoc-gen-php.1.html',
+ 'protobuf-php.3.html',
+ 'protobuf-php.5.html',
+ ]
+
+ root = "/tmp/checkout-#{Time.now.to_i}"
+ g = Git.clone(remote, root, :log => Logger.new(STDOUT))
+
+ # Make sure this actually switches branches.
+ g.checkout(g.branch('gh-pages'))
+
+ files.each {|file|
+ cp "man/#{file}", "#{root}/."
+ g.add(file)
+ }
+
+ g.commit('Regenerating Github Pages.')
+
+ # PUSH!
+ g.push(g.remote('origin'), g.branch('gh-pages'))
+
+ puts '--> GitHub Pages Commit and Push successful.'
+ end
+
+end
+
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/gtfs-realtime.php
@@ -1,1 +1,3673 @@
-
+<?php
+// DO NOT EDIT! Generated by Protobuf-PHP protoc plugin @package_version@
+// cmd line php -f protoc-gen-php.php gtfs-realtime.proto -i ./
+// Source: gtfs-realtime.proto
+// Date: 2011-08-23 07:08:46
+
+// @@protoc_insertion_point(scope_file)
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class FeedMessage extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.FeedMessage');
+
+ // required .transit_realtime.FeedHeader header = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "header";
+ $f->type = 11;
+ $f->rule = 2;
+ $f->reference = '\transit_realtime\FeedHeader';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedMessage:header)
+ $descriptor->addField($f);
+
+ // repeated .transit_realtime.FeedEntity entity = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "entity";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\transit_realtime\FeedEntity';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedMessage:entity)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.FeedMessage)
+
+ return $descriptor;
+ }
+
+ /** @var \transit_realtime\FeedHeader */
+ public $header = null;
+
+ /** @var \transit_realtime\FeedEntity[] */
+ public $entity = array();
+
+
+ /**
+ * Check if <header> has a value
+ *
+ * @return boolean
+ */
+ public function hasHeader(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <header> value
+ *
+ * @return \transit_realtime\FeedMessage
+ */
+ public function clearHeader(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <header> value
+ *
+ * @return \transit_realtime\FeedHeader
+ */
+ public function getHeader(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <header> value
+ *
+ * @param \transit_realtime\FeedHeader $value
+ * @return \transit_realtime\FeedMessage
+ */
+ public function setHeader(\transit_realtime\FeedHeader $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <entity> has a value
+ *
+ * @return boolean
+ */
+ public function hasEntity(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <entity> value
+ *
+ * @return \transit_realtime\FeedMessage
+ */
+ public function clearEntity(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <entity> value
+ *
+ * @param int $idx
+ * @return \transit_realtime\FeedEntity
+ */
+ public function getEntity($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <entity> value
+ *
+ * @param \transit_realtime\FeedEntity $value
+ * @return \transit_realtime\FeedMessage
+ */
+ public function setEntity(\transit_realtime\FeedEntity $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <entity>
+ *
+ * @return \transit_realtime\FeedEntity[]
+ */
+ public function getEntityList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <entity>
+ *
+ * @param \transit_realtime\FeedEntity $value
+ * @return \transit_realtime\FeedMessage
+ */
+ public function addEntity(\transit_realtime\FeedEntity $value){
+ return $this->_add(2, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.FeedMessage)
+ }
+}
+
+namespace transit_realtime\FeedHeader {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.FeedHeader)
+
+ class Incrementality {
+ const FULL_DATASET = 0;
+ const DIFFERENTIAL = 1;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.FeedHeader.Incrementality)
+ }
+}
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class FeedHeader extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.FeedHeader');
+
+ // required gtfs_realtime_version = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "gtfs_realtime_version";
+ $f->type = 9;
+ $f->rule = 2;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedHeader:gtfs_realtime_version)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.FeedHeader.Incrementality incrementality = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "incrementality";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\FeedHeader\Incrementality';
+ $f->default = \transit_realtime\FeedHeader\Incrementality::FULL_DATASET;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedHeader:incrementality)
+ $descriptor->addField($f);
+
+ // optional timestamp = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "timestamp";
+ $f->type = 4;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedHeader:timestamp)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.FeedHeader)
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $gtfs_realtime_version = null;
+
+ /** @var int - \transit_realtime\FeedHeader\Incrementality */
+ public $incrementality = \transit_realtime\FeedHeader\Incrementality::FULL_DATASET;
+
+ /** @var int */
+ public $timestamp = null;
+
+
+ /**
+ * Check if <gtfs_realtime_version> has a value
+ *
+ * @return boolean
+ */
+ public function hasGtfsRealtimeVersion(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <gtfs_realtime_version> value
+ *
+ * @return \transit_realtime\FeedHeader
+ */
+ public function clearGtfsRealtimeVersion(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <gtfs_realtime_version> value
+ *
+ * @return string
+ */
+ public function getGtfsRealtimeVersion(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <gtfs_realtime_version> value
+ *
+ * @param string $value
+ * @return \transit_realtime\FeedHeader
+ */
+ public function setGtfsRealtimeVersion( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <incrementality> has a value
+ *
+ * @return boolean
+ */
+ public function hasIncrementality(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <incrementality> value
+ *
+ * @return \transit_realtime\FeedHeader
+ */
+ public function clearIncrementality(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <incrementality> value
+ *
+ * @return int - \transit_realtime\FeedHeader\Incrementality
+ */
+ public function getIncrementality(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <incrementality> value
+ *
+ * @param int - \transit_realtime\FeedHeader\Incrementality $value
+ * @return \transit_realtime\FeedHeader
+ */
+ public function setIncrementality( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <timestamp> has a value
+ *
+ * @return boolean
+ */
+ public function hasTimestamp(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <timestamp> value
+ *
+ * @return \transit_realtime\FeedHeader
+ */
+ public function clearTimestamp(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <timestamp> value
+ *
+ * @return int
+ */
+ public function getTimestamp(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <timestamp> value
+ *
+ * @param int $value
+ * @return \transit_realtime\FeedHeader
+ */
+ public function setTimestamp( $value){
+ return $this->_set(3, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.FeedHeader)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class FeedEntity extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.FeedEntity');
+
+ // required id = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "id";
+ $f->type = 9;
+ $f->rule = 2;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedEntity:id)
+ $descriptor->addField($f);
+
+ // optional is_deleted = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "is_deleted";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = false;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedEntity:is_deleted)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TripUpdate trip_update = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "trip_update";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripUpdate';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedEntity:trip_update)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.VehiclePosition vehicle = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "vehicle";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\VehiclePosition';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedEntity:vehicle)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.Alert alert = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "alert";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\Alert';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.FeedEntity:alert)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.FeedEntity)
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $id = null;
+
+ /** @var boolean */
+ public $is_deleted = true;
+
+ /** @var \transit_realtime\TripUpdate */
+ public $trip_update = null;
+
+ /** @var \transit_realtime\VehiclePosition */
+ public $vehicle = null;
+
+ /** @var \transit_realtime\Alert */
+ public $alert = null;
+
+
+ /**
+ * Check if <id> has a value
+ *
+ * @return boolean
+ */
+ public function hasId(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <id> value
+ *
+ * @return \transit_realtime\FeedEntity
+ */
+ public function clearId(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <id> value
+ *
+ * @return string
+ */
+ public function getId(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\FeedEntity
+ */
+ public function setId( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <is_deleted> has a value
+ *
+ * @return boolean
+ */
+ public function hasIsDeleted(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <is_deleted> value
+ *
+ * @return \transit_realtime\FeedEntity
+ */
+ public function clearIsDeleted(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <is_deleted> value
+ *
+ * @return boolean
+ */
+ public function getIsDeleted(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <is_deleted> value
+ *
+ * @param boolean $value
+ * @return \transit_realtime\FeedEntity
+ */
+ public function setIsDeleted( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <trip_update> has a value
+ *
+ * @return boolean
+ */
+ public function hasTripUpdate(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <trip_update> value
+ *
+ * @return \transit_realtime\FeedEntity
+ */
+ public function clearTripUpdate(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <trip_update> value
+ *
+ * @return \transit_realtime\TripUpdate
+ */
+ public function getTripUpdate(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <trip_update> value
+ *
+ * @param \transit_realtime\TripUpdate $value
+ * @return \transit_realtime\FeedEntity
+ */
+ public function setTripUpdate(\transit_realtime\TripUpdate $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <vehicle> has a value
+ *
+ * @return boolean
+ */
+ public function hasVehicle(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <vehicle> value
+ *
+ * @return \transit_realtime\FeedEntity
+ */
+ public function clearVehicle(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <vehicle> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function getVehicle(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <vehicle> value
+ *
+ * @param \transit_realtime\VehiclePosition $value
+ * @return \transit_realtime\FeedEntity
+ */
+ public function setVehicle(\transit_realtime\VehiclePosition $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <alert> has a value
+ *
+ * @return boolean
+ */
+ public function hasAlert(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <alert> value
+ *
+ * @return \transit_realtime\FeedEntity
+ */
+ public function clearAlert(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <alert> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function getAlert(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <alert> value
+ *
+ * @param \transit_realtime\Alert $value
+ * @return \transit_realtime\FeedEntity
+ */
+ public function setAlert(\transit_realtime\Alert $value){
+ return $this->_set(5, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.FeedEntity)
+ }
+}
+
+namespace transit_realtime\TripUpdate {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.TripUpdate)
+
+ class StopTimeEvent extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TripUpdate.StopTimeEvent');
+
+ // optional delay = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "delay";
+ $f->type = 5;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeEvent:delay)
+ $descriptor->addField($f);
+
+ // optional time = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "time";
+ $f->type = 3;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeEvent:time)
+ $descriptor->addField($f);
+
+ // optional uncertainty = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "uncertainty";
+ $f->type = 5;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeEvent:uncertainty)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TripUpdate.StopTimeEvent)
+
+ return $descriptor;
+ }
+
+ /** @var int */
+ public $delay = null;
+
+ /** @var int */
+ public $time = null;
+
+ /** @var int */
+ public $uncertainty = null;
+
+
+ /**
+ * Check if <delay> has a value
+ *
+ * @return boolean
+ */
+ public function hasDelay(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <delay> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function clearDelay(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <delay> value
+ *
+ * @return int
+ */
+ public function getDelay(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <delay> value
+ *
+ * @param int $value
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function setDelay( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <time> has a value
+ *
+ * @return boolean
+ */
+ public function hasTime(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <time> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function clearTime(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <time> value
+ *
+ * @return int
+ */
+ public function getTime(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <time> value
+ *
+ * @param int $value
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function setTime( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <uncertainty> has a value
+ *
+ * @return boolean
+ */
+ public function hasUncertainty(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <uncertainty> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function clearUncertainty(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <uncertainty> value
+ *
+ * @return int
+ */
+ public function getUncertainty(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <uncertainty> value
+ *
+ * @param int $value
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function setUncertainty( $value){
+ return $this->_set(3, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TripUpdate.StopTimeEvent)
+ }
+}
+
+namespace transit_realtime\TripUpdate\StopTimeUpdate {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.TripUpdate.StopTimeUpdate)
+
+ class ScheduleRelationship {
+ const SCHEDULED = 0;
+ const SKIPPED = 1;
+ const NO_DATA = 2;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TripUpdate.StopTimeUpdate.ScheduleRelationship)
+ }
+}
+namespace transit_realtime\TripUpdate {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.TripUpdate)
+
+ class StopTimeUpdate extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TripUpdate.StopTimeUpdate');
+
+ // optional stop_sequence = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "stop_sequence";
+ $f->type = 13;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeUpdate:stop_sequence)
+ $descriptor->addField($f);
+
+ // optional stop_id = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "stop_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeUpdate:stop_id)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TripUpdate.StopTimeEvent arrival = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "arrival";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripUpdate\StopTimeEvent';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeUpdate:arrival)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TripUpdate.StopTimeEvent departure = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "departure";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripUpdate\StopTimeEvent';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeUpdate:departure)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TripUpdate.StopTimeUpdate.ScheduleRelationship schedule_relationship = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "schedule_relationship";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship';
+ $f->default = \transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship::SCHEDULED;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate.StopTimeUpdate:schedule_relationship)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TripUpdate.StopTimeUpdate)
+
+ return $descriptor;
+ }
+
+ /** @var int */
+ public $stop_sequence = null;
+
+ /** @var string */
+ public $stop_id = null;
+
+ /** @var \transit_realtime\TripUpdate\StopTimeEvent */
+ public $arrival = null;
+
+ /** @var \transit_realtime\TripUpdate\StopTimeEvent */
+ public $departure = null;
+
+ /** @var int - \transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship */
+ public $schedule_relationship = \transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship::SCHEDULED;
+
+
+ /**
+ * Check if <stop_sequence> has a value
+ *
+ * @return boolean
+ */
+ public function hasStopSequence(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <stop_sequence> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function clearStopSequence(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <stop_sequence> value
+ *
+ * @return int
+ */
+ public function getStopSequence(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <stop_sequence> value
+ *
+ * @param int $value
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function setStopSequence( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <stop_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasStopId(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <stop_id> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function clearStopId(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <stop_id> value
+ *
+ * @return string
+ */
+ public function getStopId(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <stop_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function setStopId( $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <arrival> has a value
+ *
+ * @return boolean
+ */
+ public function hasArrival(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <arrival> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function clearArrival(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <arrival> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function getArrival(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <arrival> value
+ *
+ * @param \transit_realtime\TripUpdate\StopTimeEvent $value
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function setArrival(\transit_realtime\TripUpdate\StopTimeEvent $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <departure> has a value
+ *
+ * @return boolean
+ */
+ public function hasDeparture(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <departure> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function clearDeparture(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <departure> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeEvent
+ */
+ public function getDeparture(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <departure> value
+ *
+ * @param \transit_realtime\TripUpdate\StopTimeEvent $value
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function setDeparture(\transit_realtime\TripUpdate\StopTimeEvent $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <schedule_relationship> has a value
+ *
+ * @return boolean
+ */
+ public function hasScheduleRelationship(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <schedule_relationship> value
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function clearScheduleRelationship(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <schedule_relationship> value
+ *
+ * @return int - \transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship
+ */
+ public function getScheduleRelationship(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <schedule_relationship> value
+ *
+ * @param int - \transit_realtime\TripUpdate\StopTimeUpdate\ScheduleRelationship $value
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function setScheduleRelationship( $value){
+ return $this->_set(5, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TripUpdate.StopTimeUpdate)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class TripUpdate extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TripUpdate');
+
+ // required .transit_realtime.TripDescriptor trip = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "trip";
+ $f->type = 11;
+ $f->rule = 2;
+ $f->reference = '\transit_realtime\TripDescriptor';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate:trip)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.VehicleDescriptor vehicle = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "vehicle";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\VehicleDescriptor';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate:vehicle)
+ $descriptor->addField($f);
+
+ // repeated .transit_realtime.TripUpdate.StopTimeUpdate stop_time_update = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "stop_time_update";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\transit_realtime\TripUpdate\StopTimeUpdate';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripUpdate:stop_time_update)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TripUpdate)
+
+ return $descriptor;
+ }
+
+ /** @var \transit_realtime\TripDescriptor */
+ public $trip = null;
+
+ /** @var \transit_realtime\VehicleDescriptor */
+ public $vehicle = null;
+
+ /** @var \transit_realtime\TripUpdate\StopTimeUpdate[] */
+ public $stop_time_update = array();
+
+
+ /**
+ * Check if <trip> has a value
+ *
+ * @return boolean
+ */
+ public function hasTrip(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <trip> value
+ *
+ * @return \transit_realtime\TripUpdate
+ */
+ public function clearTrip(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <trip> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function getTrip(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <trip> value
+ *
+ * @param \transit_realtime\TripDescriptor $value
+ * @return \transit_realtime\TripUpdate
+ */
+ public function setTrip(\transit_realtime\TripDescriptor $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <vehicle> has a value
+ *
+ * @return boolean
+ */
+ public function hasVehicle(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <vehicle> value
+ *
+ * @return \transit_realtime\TripUpdate
+ */
+ public function clearVehicle(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <vehicle> value
+ *
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function getVehicle(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <vehicle> value
+ *
+ * @param \transit_realtime\VehicleDescriptor $value
+ * @return \transit_realtime\TripUpdate
+ */
+ public function setVehicle(\transit_realtime\VehicleDescriptor $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <stop_time_update> has a value
+ *
+ * @return boolean
+ */
+ public function hasStopTimeUpdate(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <stop_time_update> value
+ *
+ * @return \transit_realtime\TripUpdate
+ */
+ public function clearStopTimeUpdate(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <stop_time_update> value
+ *
+ * @param int $idx
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate
+ */
+ public function getStopTimeUpdate($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <stop_time_update> value
+ *
+ * @param \transit_realtime\TripUpdate\StopTimeUpdate $value
+ * @return \transit_realtime\TripUpdate
+ */
+ public function setStopTimeUpdate(\transit_realtime\TripUpdate\StopTimeUpdate $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <stop_time_update>
+ *
+ * @return \transit_realtime\TripUpdate\StopTimeUpdate[]
+ */
+ public function getStopTimeUpdateList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <stop_time_update>
+ *
+ * @param \transit_realtime\TripUpdate\StopTimeUpdate $value
+ * @return \transit_realtime\TripUpdate
+ */
+ public function addStopTimeUpdate(\transit_realtime\TripUpdate\StopTimeUpdate $value){
+ return $this->_add(2, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TripUpdate)
+ }
+}
+
+namespace transit_realtime\VehiclePosition {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.VehiclePosition)
+
+ class VehicleStopStatus {
+ const INCOMING_AT = 0;
+ const STOPPED_AT = 1;
+ const IN_TRANSIT_TO = 2;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.VehiclePosition.VehicleStopStatus)
+ }
+}
+namespace transit_realtime\VehiclePosition {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.VehiclePosition)
+
+ class CongestionLevel {
+ const UNKNOWN_CONGESTION_LEVEL = 0;
+ const RUNNING_SMOOTHLY = 1;
+ const STOP_AND_GO = 2;
+ const CONGESTION = 3;
+ const SEVERE_CONGESTION = 4;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.VehiclePosition.CongestionLevel)
+ }
+}
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class VehiclePosition extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.VehiclePosition');
+
+ // optional .transit_realtime.TripDescriptor trip = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "trip";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripDescriptor';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:trip)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.VehicleDescriptor vehicle = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "vehicle";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\VehicleDescriptor';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:vehicle)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.Position position = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "position";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\Position';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:position)
+ $descriptor->addField($f);
+
+ // optional current_stop_sequence = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "current_stop_sequence";
+ $f->type = 13;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:current_stop_sequence)
+ $descriptor->addField($f);
+
+ // optional stop_id = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "stop_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:stop_id)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.VehiclePosition.VehicleStopStatus current_status = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "current_status";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\VehiclePosition\VehicleStopStatus';
+ $f->default = \transit_realtime\VehiclePosition\VehicleStopStatus::IN_TRANSIT_TO;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:current_status)
+ $descriptor->addField($f);
+
+ // optional timestamp = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "timestamp";
+ $f->type = 4;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:timestamp)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.VehiclePosition.CongestionLevel congestion_level = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "congestion_level";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\VehiclePosition\CongestionLevel';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehiclePosition:congestion_level)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.VehiclePosition)
+
+ return $descriptor;
+ }
+
+ /** @var \transit_realtime\TripDescriptor */
+ public $trip = null;
+
+ /** @var \transit_realtime\VehicleDescriptor */
+ public $vehicle = null;
+
+ /** @var \transit_realtime\Position */
+ public $position = null;
+
+ /** @var int */
+ public $current_stop_sequence = null;
+
+ /** @var string */
+ public $stop_id = null;
+
+ /** @var int - \transit_realtime\VehiclePosition\VehicleStopStatus */
+ public $current_status = \transit_realtime\VehiclePosition\VehicleStopStatus::IN_TRANSIT_TO;
+
+ /** @var int */
+ public $timestamp = null;
+
+ /** @var int - \transit_realtime\VehiclePosition\CongestionLevel */
+ public $congestion_level = null;
+
+
+ /**
+ * Check if <trip> has a value
+ *
+ * @return boolean
+ */
+ public function hasTrip(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <trip> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearTrip(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <trip> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function getTrip(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <trip> value
+ *
+ * @param \transit_realtime\TripDescriptor $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setTrip(\transit_realtime\TripDescriptor $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <vehicle> has a value
+ *
+ * @return boolean
+ */
+ public function hasVehicle(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <vehicle> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearVehicle(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <vehicle> value
+ *
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function getVehicle(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <vehicle> value
+ *
+ * @param \transit_realtime\VehicleDescriptor $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setVehicle(\transit_realtime\VehicleDescriptor $value){
+ return $this->_set(8, $value);
+ }
+
+ /**
+ * Check if <position> has a value
+ *
+ * @return boolean
+ */
+ public function hasPosition(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <position> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearPosition(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <position> value
+ *
+ * @return \transit_realtime\Position
+ */
+ public function getPosition(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <position> value
+ *
+ * @param \transit_realtime\Position $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setPosition(\transit_realtime\Position $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <current_stop_sequence> has a value
+ *
+ * @return boolean
+ */
+ public function hasCurrentStopSequence(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <current_stop_sequence> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearCurrentStopSequence(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <current_stop_sequence> value
+ *
+ * @return int
+ */
+ public function getCurrentStopSequence(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <current_stop_sequence> value
+ *
+ * @param int $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setCurrentStopSequence( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <stop_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasStopId(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <stop_id> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearStopId(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <stop_id> value
+ *
+ * @return string
+ */
+ public function getStopId(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Set <stop_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setStopId( $value){
+ return $this->_set(7, $value);
+ }
+
+ /**
+ * Check if <current_status> has a value
+ *
+ * @return boolean
+ */
+ public function hasCurrentStatus(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <current_status> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearCurrentStatus(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <current_status> value
+ *
+ * @return int - \transit_realtime\VehiclePosition\VehicleStopStatus
+ */
+ public function getCurrentStatus(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <current_status> value
+ *
+ * @param int - \transit_realtime\VehiclePosition\VehicleStopStatus $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setCurrentStatus( $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <timestamp> has a value
+ *
+ * @return boolean
+ */
+ public function hasTimestamp(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <timestamp> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearTimestamp(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <timestamp> value
+ *
+ * @return int
+ */
+ public function getTimestamp(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <timestamp> value
+ *
+ * @param int $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setTimestamp( $value){
+ return $this->_set(5, $value);
+ }
+
+ /**
+ * Check if <congestion_level> has a value
+ *
+ * @return boolean
+ */
+ public function hasCongestionLevel(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <congestion_level> value
+ *
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function clearCongestionLevel(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <congestion_level> value
+ *
+ * @return int - \transit_realtime\VehiclePosition\CongestionLevel
+ */
+ public function getCongestionLevel(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Set <congestion_level> value
+ *
+ * @param int - \transit_realtime\VehiclePosition\CongestionLevel $value
+ * @return \transit_realtime\VehiclePosition
+ */
+ public function setCongestionLevel( $value){
+ return $this->_set(6, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.VehiclePosition)
+ }
+}
+
+namespace transit_realtime\Alert {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.Alert)
+
+ class Cause {
+ const UNKNOWN_CAUSE = 1;
+ const OTHER_CAUSE = 2;
+ const TECHNICAL_PROBLEM = 3;
+ const STRIKE = 4;
+ const DEMONSTRATION = 5;
+ const ACCIDENT = 6;
+ const HOLIDAY = 7;
+ const WEATHER = 8;
+ const MAINTENANCE = 9;
+ const CONSTRUCTION = 10;
+ const POLICE_ACTIVITY = 11;
+ const MEDICAL_EMERGENCY = 12;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.Alert.Cause)
+ }
+}
+namespace transit_realtime\Alert {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.Alert)
+
+ class Effect {
+ const NO_SERVICE = 1;
+ const REDUCED_SERVICE = 2;
+ const SIGNIFICANT_DELAYS = 3;
+ const DETOUR = 4;
+ const ADDITIONAL_SERVICE = 5;
+ const MODIFIED_SERVICE = 6;
+ const OTHER_EFFECT = 7;
+ const UNKNOWN_EFFECT = 8;
+ const STOP_MOVED = 9;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.Alert.Effect)
+ }
+}
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class Alert extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.Alert');
+
+ // repeated .transit_realtime.TimeRange active_period = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "active_period";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\transit_realtime\TimeRange';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:active_period)
+ $descriptor->addField($f);
+
+ // repeated .transit_realtime.EntitySelector informed_entity = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "informed_entity";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\transit_realtime\EntitySelector';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:informed_entity)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.Alert.Cause cause = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "cause";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\Alert\Cause';
+ $f->default = \transit_realtime\Alert\Cause::UNKNOWN_CAUSE;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:cause)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.Alert.Effect effect = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "effect";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\Alert\Effect';
+ $f->default = \transit_realtime\Alert\Effect::UNKNOWN_EFFECT;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:effect)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TranslatedString url = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "url";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TranslatedString';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:url)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TranslatedString header_text = 10
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 10;
+ $f->name = "header_text";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TranslatedString';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:header_text)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TranslatedString description_text = 11
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 11;
+ $f->name = "description_text";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TranslatedString';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Alert:description_text)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.Alert)
+
+ return $descriptor;
+ }
+
+ /** @var \transit_realtime\TimeRange[] */
+ public $active_period = array();
+
+ /** @var \transit_realtime\EntitySelector[] */
+ public $informed_entity = array();
+
+ /** @var int - \transit_realtime\Alert\Cause */
+ public $cause = \transit_realtime\Alert\Cause::UNKNOWN_CAUSE;
+
+ /** @var int - \transit_realtime\Alert\Effect */
+ public $effect = \transit_realtime\Alert\Effect::UNKNOWN_EFFECT;
+
+ /** @var \transit_realtime\TranslatedString */
+ public $url = null;
+
+ /** @var \transit_realtime\TranslatedString */
+ public $header_text = null;
+
+ /** @var \transit_realtime\TranslatedString */
+ public $description_text = null;
+
+
+ /**
+ * Check if <active_period> has a value
+ *
+ * @return boolean
+ */
+ public function hasActivePeriod(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <active_period> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearActivePeriod(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <active_period> value
+ *
+ * @param int $idx
+ * @return \transit_realtime\TimeRange
+ */
+ public function getActivePeriod($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <active_period> value
+ *
+ * @param \transit_realtime\TimeRange $value
+ * @return \transit_realtime\Alert
+ */
+ public function setActivePeriod(\transit_realtime\TimeRange $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <active_period>
+ *
+ * @return \transit_realtime\TimeRange[]
+ */
+ public function getActivePeriodList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <active_period>
+ *
+ * @param \transit_realtime\TimeRange $value
+ * @return \transit_realtime\Alert
+ */
+ public function addActivePeriod(\transit_realtime\TimeRange $value){
+ return $this->_add(1, $value);
+ }
+
+ /**
+ * Check if <informed_entity> has a value
+ *
+ * @return boolean
+ */
+ public function hasInformedEntity(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <informed_entity> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearInformedEntity(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <informed_entity> value
+ *
+ * @param int $idx
+ * @return \transit_realtime\EntitySelector
+ */
+ public function getInformedEntity($idx = NULL){
+ return $this->_get(5, $idx);
+ }
+
+ /**
+ * Set <informed_entity> value
+ *
+ * @param \transit_realtime\EntitySelector $value
+ * @return \transit_realtime\Alert
+ */
+ public function setInformedEntity(\transit_realtime\EntitySelector $value, $idx = NULL){
+ return $this->_set(5, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <informed_entity>
+ *
+ * @return \transit_realtime\EntitySelector[]
+ */
+ public function getInformedEntityList(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Add a new element to <informed_entity>
+ *
+ * @param \transit_realtime\EntitySelector $value
+ * @return \transit_realtime\Alert
+ */
+ public function addInformedEntity(\transit_realtime\EntitySelector $value){
+ return $this->_add(5, $value);
+ }
+
+ /**
+ * Check if <cause> has a value
+ *
+ * @return boolean
+ */
+ public function hasCause(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <cause> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearCause(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <cause> value
+ *
+ * @return int - \transit_realtime\Alert\Cause
+ */
+ public function getCause(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Set <cause> value
+ *
+ * @param int - \transit_realtime\Alert\Cause $value
+ * @return \transit_realtime\Alert
+ */
+ public function setCause( $value){
+ return $this->_set(6, $value);
+ }
+
+ /**
+ * Check if <effect> has a value
+ *
+ * @return boolean
+ */
+ public function hasEffect(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <effect> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearEffect(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <effect> value
+ *
+ * @return int - \transit_realtime\Alert\Effect
+ */
+ public function getEffect(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Set <effect> value
+ *
+ * @param int - \transit_realtime\Alert\Effect $value
+ * @return \transit_realtime\Alert
+ */
+ public function setEffect( $value){
+ return $this->_set(7, $value);
+ }
+
+ /**
+ * Check if <url> has a value
+ *
+ * @return boolean
+ */
+ public function hasUrl(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <url> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearUrl(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <url> value
+ *
+ * @return \transit_realtime\TranslatedString
+ */
+ public function getUrl(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <url> value
+ *
+ * @param \transit_realtime\TranslatedString $value
+ * @return \transit_realtime\Alert
+ */
+ public function setUrl(\transit_realtime\TranslatedString $value){
+ return $this->_set(8, $value);
+ }
+
+ /**
+ * Check if <header_text> has a value
+ *
+ * @return boolean
+ */
+ public function hasHeaderText(){
+ return $this->_has(10);
+ }
+
+ /**
+ * Clear <header_text> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearHeaderText(){
+ return $this->_clear(10);
+ }
+
+ /**
+ * Get <header_text> value
+ *
+ * @return \transit_realtime\TranslatedString
+ */
+ public function getHeaderText(){
+ return $this->_get(10);
+ }
+
+ /**
+ * Set <header_text> value
+ *
+ * @param \transit_realtime\TranslatedString $value
+ * @return \transit_realtime\Alert
+ */
+ public function setHeaderText(\transit_realtime\TranslatedString $value){
+ return $this->_set(10, $value);
+ }
+
+ /**
+ * Check if <description_text> has a value
+ *
+ * @return boolean
+ */
+ public function hasDescriptionText(){
+ return $this->_has(11);
+ }
+
+ /**
+ * Clear <description_text> value
+ *
+ * @return \transit_realtime\Alert
+ */
+ public function clearDescriptionText(){
+ return $this->_clear(11);
+ }
+
+ /**
+ * Get <description_text> value
+ *
+ * @return \transit_realtime\TranslatedString
+ */
+ public function getDescriptionText(){
+ return $this->_get(11);
+ }
+
+ /**
+ * Set <description_text> value
+ *
+ * @param \transit_realtime\TranslatedString $value
+ * @return \transit_realtime\Alert
+ */
+ public function setDescriptionText(\transit_realtime\TranslatedString $value){
+ return $this->_set(11, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.Alert)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class TimeRange extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TimeRange');
+
+ // optional start = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "start";
+ $f->type = 4;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TimeRange:start)
+ $descriptor->addField($f);
+
+ // optional end = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "end";
+ $f->type = 4;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TimeRange:end)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TimeRange)
+
+ return $descriptor;
+ }
+
+ /** @var int */
+ public $start = null;
+
+ /** @var int */
+ public $end = null;
+
+
+ /**
+ * Check if <start> has a value
+ *
+ * @return boolean
+ */
+ public function hasStart(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <start> value
+ *
+ * @return \transit_realtime\TimeRange
+ */
+ public function clearStart(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <start> value
+ *
+ * @return int
+ */
+ public function getStart(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <start> value
+ *
+ * @param int $value
+ * @return \transit_realtime\TimeRange
+ */
+ public function setStart( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <end> has a value
+ *
+ * @return boolean
+ */
+ public function hasEnd(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <end> value
+ *
+ * @return \transit_realtime\TimeRange
+ */
+ public function clearEnd(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <end> value
+ *
+ * @return int
+ */
+ public function getEnd(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <end> value
+ *
+ * @param int $value
+ * @return \transit_realtime\TimeRange
+ */
+ public function setEnd( $value){
+ return $this->_set(2, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TimeRange)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class Position extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.Position');
+
+ // required latitude = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "latitude";
+ $f->type = 2;
+ $f->rule = 2;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Position:latitude)
+ $descriptor->addField($f);
+
+ // required longitude = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "longitude";
+ $f->type = 2;
+ $f->rule = 2;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Position:longitude)
+ $descriptor->addField($f);
+
+ // optional bearing = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "bearing";
+ $f->type = 2;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Position:bearing)
+ $descriptor->addField($f);
+
+ // optional odometer = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "odometer";
+ $f->type = 1;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Position:odometer)
+ $descriptor->addField($f);
+
+ // optional speed = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "speed";
+ $f->type = 2;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.Position:speed)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.Position)
+
+ return $descriptor;
+ }
+
+ /** @var float */
+ public $latitude = null;
+
+ /** @var float */
+ public $longitude = null;
+
+ /** @var float */
+ public $bearing = null;
+
+ /** @var float */
+ public $odometer = null;
+
+ /** @var float */
+ public $speed = null;
+
+
+ /**
+ * Check if <latitude> has a value
+ *
+ * @return boolean
+ */
+ public function hasLatitude(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <latitude> value
+ *
+ * @return \transit_realtime\Position
+ */
+ public function clearLatitude(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <latitude> value
+ *
+ * @return float
+ */
+ public function getLatitude(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <latitude> value
+ *
+ * @param float $value
+ * @return \transit_realtime\Position
+ */
+ public function setLatitude( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <longitude> has a value
+ *
+ * @return boolean
+ */
+ public function hasLongitude(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <longitude> value
+ *
+ * @return \transit_realtime\Position
+ */
+ public function clearLongitude(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <longitude> value
+ *
+ * @return float
+ */
+ public function getLongitude(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <longitude> value
+ *
+ * @param float $value
+ * @return \transit_realtime\Position
+ */
+ public function setLongitude( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <bearing> has a value
+ *
+ * @return boolean
+ */
+ public function hasBearing(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <bearing> value
+ *
+ * @return \transit_realtime\Position
+ */
+ public function clearBearing(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <bearing> value
+ *
+ * @return float
+ */
+ public function getBearing(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <bearing> value
+ *
+ * @param float $value
+ * @return \transit_realtime\Position
+ */
+ public function setBearing( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <odometer> has a value
+ *
+ * @return boolean
+ */
+ public function hasOdometer(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <odometer> value
+ *
+ * @return \transit_realtime\Position
+ */
+ public function clearOdometer(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <odometer> value
+ *
+ * @return float
+ */
+ public function getOdometer(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <odometer> value
+ *
+ * @param float $value
+ * @return \transit_realtime\Position
+ */
+ public function setOdometer( $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <speed> has a value
+ *
+ * @return boolean
+ */
+ public function hasSpeed(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <speed> value
+ *
+ * @return \transit_realtime\Position
+ */
+ public function clearSpeed(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <speed> value
+ *
+ * @return float
+ */
+ public function getSpeed(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <speed> value
+ *
+ * @param float $value
+ * @return \transit_realtime\Position
+ */
+ public function setSpeed( $value){
+ return $this->_set(5, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.Position)
+ }
+}
+
+namespace transit_realtime\TripDescriptor {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.TripDescriptor)
+
+ class ScheduleRelationship {
+ const SCHEDULED = 0;
+ const ADDED = 1;
+ const UNSCHEDULED = 2;
+ const CANCELED = 3;
+ const REPLACEMENT = 5;
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TripDescriptor.ScheduleRelationship)
+ }
+}
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class TripDescriptor extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TripDescriptor');
+
+ // optional trip_id = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "trip_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripDescriptor:trip_id)
+ $descriptor->addField($f);
+
+ // optional route_id = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "route_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripDescriptor:route_id)
+ $descriptor->addField($f);
+
+ // optional start_time = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "start_time";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripDescriptor:start_time)
+ $descriptor->addField($f);
+
+ // optional start_date = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "start_date";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripDescriptor:start_date)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TripDescriptor.ScheduleRelationship schedule_relationship = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "schedule_relationship";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripDescriptor\ScheduleRelationship';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TripDescriptor:schedule_relationship)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TripDescriptor)
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $trip_id = null;
+
+ /** @var string */
+ public $route_id = null;
+
+ /** @var string */
+ public $start_time = null;
+
+ /** @var string */
+ public $start_date = null;
+
+ /** @var int - \transit_realtime\TripDescriptor\ScheduleRelationship */
+ public $schedule_relationship = null;
+
+
+ /**
+ * Check if <trip_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasTripId(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <trip_id> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function clearTripId(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <trip_id> value
+ *
+ * @return string
+ */
+ public function getTripId(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <trip_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function setTripId( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <route_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasRouteId(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <route_id> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function clearRouteId(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <route_id> value
+ *
+ * @return string
+ */
+ public function getRouteId(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <route_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function setRouteId( $value){
+ return $this->_set(5, $value);
+ }
+
+ /**
+ * Check if <start_time> has a value
+ *
+ * @return boolean
+ */
+ public function hasStartTime(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <start_time> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function clearStartTime(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <start_time> value
+ *
+ * @return string
+ */
+ public function getStartTime(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <start_time> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function setStartTime( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <start_date> has a value
+ *
+ * @return boolean
+ */
+ public function hasStartDate(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <start_date> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function clearStartDate(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <start_date> value
+ *
+ * @return string
+ */
+ public function getStartDate(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <start_date> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function setStartDate( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <schedule_relationship> has a value
+ *
+ * @return boolean
+ */
+ public function hasScheduleRelationship(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <schedule_relationship> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function clearScheduleRelationship(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <schedule_relationship> value
+ *
+ * @return int - \transit_realtime\TripDescriptor\ScheduleRelationship
+ */
+ public function getScheduleRelationship(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <schedule_relationship> value
+ *
+ * @param int - \transit_realtime\TripDescriptor\ScheduleRelationship $value
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function setScheduleRelationship( $value){
+ return $this->_set(4, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TripDescriptor)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class VehicleDescriptor extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.VehicleDescriptor');
+
+ // optional id = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehicleDescriptor:id)
+ $descriptor->addField($f);
+
+ // optional label = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "label";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehicleDescriptor:label)
+ $descriptor->addField($f);
+
+ // optional license_plate = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "license_plate";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.VehicleDescriptor:license_plate)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.VehicleDescriptor)
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $id = null;
+
+ /** @var string */
+ public $label = null;
+
+ /** @var string */
+ public $license_plate = null;
+
+
+ /**
+ * Check if <id> has a value
+ *
+ * @return boolean
+ */
+ public function hasId(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <id> value
+ *
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function clearId(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <id> value
+ *
+ * @return string
+ */
+ public function getId(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function setId( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <label> has a value
+ *
+ * @return boolean
+ */
+ public function hasLabel(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <label> value
+ *
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function clearLabel(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <label> value
+ *
+ * @return string
+ */
+ public function getLabel(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <label> value
+ *
+ * @param string $value
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function setLabel( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <license_plate> has a value
+ *
+ * @return boolean
+ */
+ public function hasLicensePlate(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <license_plate> value
+ *
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function clearLicensePlate(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <license_plate> value
+ *
+ * @return string
+ */
+ public function getLicensePlate(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <license_plate> value
+ *
+ * @param string $value
+ * @return \transit_realtime\VehicleDescriptor
+ */
+ public function setLicensePlate( $value){
+ return $this->_set(3, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.VehicleDescriptor)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class EntitySelector extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.EntitySelector');
+
+ // optional agency_id = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "agency_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.EntitySelector:agency_id)
+ $descriptor->addField($f);
+
+ // optional route_id = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "route_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.EntitySelector:route_id)
+ $descriptor->addField($f);
+
+ // optional route_type = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "route_type";
+ $f->type = 5;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.EntitySelector:route_type)
+ $descriptor->addField($f);
+
+ // optional .transit_realtime.TripDescriptor trip = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "trip";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = '\transit_realtime\TripDescriptor';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.EntitySelector:trip)
+ $descriptor->addField($f);
+
+ // optional stop_id = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "stop_id";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.EntitySelector:stop_id)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.EntitySelector)
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $agency_id = null;
+
+ /** @var string */
+ public $route_id = null;
+
+ /** @var int */
+ public $route_type = null;
+
+ /** @var \transit_realtime\TripDescriptor */
+ public $trip = null;
+
+ /** @var string */
+ public $stop_id = null;
+
+
+ /**
+ * Check if <agency_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasAgencyId(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <agency_id> value
+ *
+ * @return \transit_realtime\EntitySelector
+ */
+ public function clearAgencyId(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <agency_id> value
+ *
+ * @return string
+ */
+ public function getAgencyId(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <agency_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\EntitySelector
+ */
+ public function setAgencyId( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <route_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasRouteId(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <route_id> value
+ *
+ * @return \transit_realtime\EntitySelector
+ */
+ public function clearRouteId(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <route_id> value
+ *
+ * @return string
+ */
+ public function getRouteId(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <route_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\EntitySelector
+ */
+ public function setRouteId( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <route_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasRouteType(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <route_type> value
+ *
+ * @return \transit_realtime\EntitySelector
+ */
+ public function clearRouteType(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <route_type> value
+ *
+ * @return int
+ */
+ public function getRouteType(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <route_type> value
+ *
+ * @param int $value
+ * @return \transit_realtime\EntitySelector
+ */
+ public function setRouteType( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <trip> has a value
+ *
+ * @return boolean
+ */
+ public function hasTrip(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <trip> value
+ *
+ * @return \transit_realtime\EntitySelector
+ */
+ public function clearTrip(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <trip> value
+ *
+ * @return \transit_realtime\TripDescriptor
+ */
+ public function getTrip(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <trip> value
+ *
+ * @param \transit_realtime\TripDescriptor $value
+ * @return \transit_realtime\EntitySelector
+ */
+ public function setTrip(\transit_realtime\TripDescriptor $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <stop_id> has a value
+ *
+ * @return boolean
+ */
+ public function hasStopId(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <stop_id> value
+ *
+ * @return \transit_realtime\EntitySelector
+ */
+ public function clearStopId(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <stop_id> value
+ *
+ * @return string
+ */
+ public function getStopId(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <stop_id> value
+ *
+ * @param string $value
+ * @return \transit_realtime\EntitySelector
+ */
+ public function setStopId( $value){
+ return $this->_set(5, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.EntitySelector)
+ }
+}
+
+namespace transit_realtime\TranslatedString {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime.TranslatedString)
+
+ class Translation extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TranslatedString.Translation');
+
+ // required text = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "text";
+ $f->type = 9;
+ $f->rule = 2;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TranslatedString.Translation:text)
+ $descriptor->addField($f);
+
+ // optional language = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "language";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TranslatedString.Translation:language)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TranslatedString.Translation)
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $text = null;
+
+ /** @var string */
+ public $language = null;
+
+
+ /**
+ * Check if <text> has a value
+ *
+ * @return boolean
+ */
+ public function hasText(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <text> value
+ *
+ * @return \transit_realtime\TranslatedString\Translation
+ */
+ public function clearText(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <text> value
+ *
+ * @return string
+ */
+ public function getText(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <text> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TranslatedString\Translation
+ */
+ public function setText( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <language> has a value
+ *
+ * @return boolean
+ */
+ public function hasLanguage(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <language> value
+ *
+ * @return \transit_realtime\TranslatedString\Translation
+ */
+ public function clearLanguage(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <language> value
+ *
+ * @return string
+ */
+ public function getLanguage(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <language> value
+ *
+ * @param string $value
+ * @return \transit_realtime\TranslatedString\Translation
+ */
+ public function setLanguage( $value){
+ return $this->_set(2, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TranslatedString.Translation)
+ }
+}
+
+namespace transit_realtime {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_transit_realtime)
+
+ class TranslatedString extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, 'transit_realtime.TranslatedString');
+
+ // repeated .transit_realtime.TranslatedString.Translation translation = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "translation";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\transit_realtime\TranslatedString\Translation';
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_transit_realtime.TranslatedString:translation)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_transit_realtime.TranslatedString)
+
+ return $descriptor;
+ }
+
+ /** @var \transit_realtime\TranslatedString\Translation[] */
+ public $translation = array();
+
+
+ /**
+ * Check if <translation> has a value
+ *
+ * @return boolean
+ */
+ public function hasTranslation(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <translation> value
+ *
+ * @return \transit_realtime\TranslatedString
+ */
+ public function clearTranslation(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <translation> value
+ *
+ * @param int $idx
+ * @return \transit_realtime\TranslatedString\Translation
+ */
+ public function getTranslation($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <translation> value
+ *
+ * @param \transit_realtime\TranslatedString\Translation $value
+ * @return \transit_realtime\TranslatedString
+ */
+ public function setTranslation(\transit_realtime\TranslatedString\Translation $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <translation>
+ *
+ * @return \transit_realtime\TranslatedString\Translation[]
+ */
+ public function getTranslationList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <translation>
+ *
+ * @param \transit_realtime\TranslatedString\Translation $value
+ * @return \transit_realtime\TranslatedString
+ */
+ public function addTranslation(\transit_realtime\TranslatedString\Translation $value){
+ return $this->_add(1, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_transit_realtime.TranslatedString)
+ }
+}
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/gtfs-realtime.proto
@@ -1,1 +1,498 @@
-
+// Copyright 2010 Google Inc
+//
+// The content of this file is licensed under the Creative Commons Attribution
+// 3.0 License.
+//
+// Protocol definition file for GTFS-realtime.
+//
+// GTFS-realtime lets transit agencies provide consumers with realtime
+// information about disruptions to their service (stations closed, lines not
+// operating, important delays etc), location of their vehicles and expected
+// arrival times.
+//
+// This protocol is published on http://code.google.com/transit/realtime/ .
+
+syntax = "proto2";
+
+option cc_api_version = 2;
+option py_api_version = 1;
+
+option java_package = "com.google.transit.realtime";
+package transit_realtime;
+
+// The contents of a feed message.
+// A feed is a continuous stream of feed messages. Each message in the stream is
+// obtained as a response to an appropriate HTTP GET request.
+// A realtime feed is always defined with relation to an existing GTFS feed.
+// All the entity ids are resolved with respect to the GTFS feed.
+//
+// A feed depends on some external configuration:
+// - The corresponding GTFS feed.
+// - Feed application (updates, positions or alerts). A feed should contain only
+// items of one specified application; all the other entities will be ignored.
+// - Polling frequency
+message FeedMessage {
+ // Metadata about this feed and feed message.
+ required FeedHeader header = 1;
+
+ // Contents of the feed.
+ repeated FeedEntity entity = 2;
+}
+
+// Metadata about a feed, included in feed messages.
+message FeedHeader {
+ // Version of the feed specification.
+ // The current version is 1.0.
+ required string gtfs_realtime_version = 1;
+
+ // Determines whether the current fetch is incremental.
+ enum Incrementality {
+ FULL_DATASET = 0;
+ DIFFERENTIAL = 1;
+ }
+ optional Incrementality incrementality = 2 [default = FULL_DATASET];
+
+ // This timestamp identifies the moment when the content of this feed has been
+ // created (in server time). In POSIX time (i.e., number of seconds since
+ // January 1st 1970 00:00:00 UTC).
+ optional uint64 timestamp = 3;
+}
+
+// A definition (or update) of an entity in the transit feed.
+message FeedEntity {
+ // The ids are used only to provide incrementality support. The id should be
+ // unique within a FeedMessage. Consequent FeedMessages may contain
+ // FeedEntities with the same id. In case of a DIFFERENTIAL update the new
+ // FeedEntity with some id will replace the old FeedEntity with the same id
+ // (or delete it - see is_deleted below).
+ // The actual GTFS entities (e.g. stations, routes, trips) referenced by the
+ // feed must be specified by explicit selectors (see EntitySelector below for
+ // more info).
+ required string id = 1;
+
+ // Whether this entity is to be deleted. Relevant only for incremental
+ // fetches.
+ optional bool is_deleted = 2 [default = false];
+
+ // Data about the entity itself. Exactly one of the following fields must be
+ // present (unless the entity is being deleted).
+ optional TripUpdate trip_update = 3;
+ optional VehiclePosition vehicle = 4;
+ optional Alert alert = 5;
+}
+
+//
+// Entities used in the feed.
+//
+
+// Realtime update of the progress of a vehicle along a trip.
+// Depending on the value of ScheduleRelationship, a TripUpdate can specify:
+// - A trip that proceeds along the schedule.
+// - A trip that proceeds along a route but has no fixed schedule.
+// - A trip that have been added or removed with regard to schedule.
+//
+// The updates can be for future, predicted arrival/departure events, or for
+// past events that already occurred.
+// Normally, updates should get more precise and more certain (see
+// uncertainty below) as the events gets closer to current time.
+// Even if that is not possible, the information for past events should be
+// precise and certain. In particular, if an update points to time in the past
+// but its update's uncertainty is not 0, the client should conclude that the
+// update is a (wrong) prediction and that the trip has not completed yet.
+//
+// Note that the update can describe a trip that is already completed.
+// To this end, it is enough to provide an update for the last stop of the trip.
+// If the time of that is in the past, the client will conclude from that that
+// the whole trip is in the past (it is possible, although inconsequential, to
+// also provide updates for preceding stops).
+// This option is most relevant for a trip that has completed ahead of schedule,
+// but according to the schedule, the trip is still proceeding at the current
+// time. Removing the updates for this trip could make the client assume
+// that the trip is still proceeding.
+// Note that the feed provider is allowed, but not required, to purge past
+// updates - this is one case where this would be practically useful.
+message TripUpdate {
+ // The Trip that this message applies to. There can be at most one
+ // TripUpdate entity for each actual trip instance.
+ // If there is none, that means there is no prediction information available.
+ // It does *not* mean that the trip is progressing according to schedule.
+ required TripDescriptor trip = 1;
+
+ // Additional information on the vehicle that is serving this trip.
+ optional VehicleDescriptor vehicle = 3;
+
+ // Timing information for a single predicted event (either arrival or
+ // departure).
+ // Timing consists of delay and/or estimated time, and uncertainty.
+ // - delay should be used when the prediction is given relative to some
+ // existing schedule in GTFS.
+ // - time should be given whether there is a predicted schedule or not. If
+ // both time and delay are specified, time will take precedence
+ // (although normally, time, if given for a scheduled trip, should be
+ // equal to scheduled time in GTFS + delay).
+ //
+ // Uncertainty applies equally to both time and delay.
+ // The uncertainty roughly specifies the expected error in true delay (but
+ // note, we don't yet define its precise statistical meaning). It's possible
+ // for the uncertainty to be 0, for example for trains that are driven under
+ // computer timing control.
+ message StopTimeEvent {
+ // Delay (in seconds) can be positive (meaning that the vehicle is late) or
+ // negative (meaning that the vehicle is ahead of schedule). Delay of 0
+ // means that the vehicle is exactly on time.
+ optional int32 delay = 1;
+
+ // Event as absolute time.
+ // In Unix time (i.e., number of seconds since January 1st 1970 00:00:00
+ // UTC).
+ optional int64 time = 2;
+
+ // If uncertainty is omitted, it is interpreted as unknown.
+ // If the prediction is unknown or too uncertain, the delay (or time) field
+ // should be empty. In such case, the uncertainty field is ignored.
+ // To specify a completely certain prediction, set its uncertainty to 0.
+ optional int32 uncertainty = 3;
+ }
+
+ // Realtime update for arrival and/or departure events for a given stop on a
+ // trip. Updates can be supplied for both past and future events.
+ // The producer is allowed, although not required, to drop past events.
+ message StopTimeUpdate {
+ // The update is linked to a specific stop either through stop_sequence or
+ // stop_id, so one of the fields below must necessarily be set.
+ // See the documentation in TripDescriptor for more information.
+
+ // Must be the same as in stop_times.txt in the corresponding GTFS feed.
+ optional uint32 stop_sequence = 1;
+ // Must be the same as in stops.txt in the corresponding GTFS feed.
+ optional string stop_id = 4;
+
+ optional StopTimeEvent arrival = 2;
+ optional StopTimeEvent departure = 3;
+
+ // The relation between this StopTime and the static schedule.
+ enum ScheduleRelationship {
+ // The vehicle is proceeding in accordance with its static schedule of
+ // stops, although not necessarily according to the times of the schedule.
+ // At least one of arrival and departure must be provided. If the schedule
+ // for this stop contains both arrival and departure times then so must
+ // this update. An update with only an arrival, say, where the schedule
+ // has both, indicates that the trip is terminating early at this stop.
+ SCHEDULED = 0;
+
+ // The stop is skipped, i.e., the vehicle will not stop at this stop.
+ // Arrival and departure are optional.
+ SKIPPED = 1;
+
+ // No data is given for this stop. The main intention for this value is to
+ // give the predictions only for part of a trip, i.e., if the last update
+ // for a trip has a NO_DATA specifier, then StopTimes for the rest of the
+ // stops in the trip are considered to be unspecified as well.
+ // Neither arrival nor departure should be supplied.
+ NO_DATA = 2;
+ }
+ optional ScheduleRelationship schedule_relationship = 5
+ [default = SCHEDULED];
+ }
+
+ // Updates to StopTimes for the trip (both future, i.e., predictions, and in
+ // some cases, past ones, i.e., those that already happened).
+ // The updates must be sorted by stop_sequence, and apply for all the
+ // following stops of the trip up to the next specified one.
+ //
+ // Example 1:
+ // For a trip with 20 stops, a StopTimeUpdate with arrival delay and departure
+ // delay of 0 for stop_sequence of the current stop means that the trip is
+ // exactly on time.
+ //
+ // Example 2:
+ // For the same trip instance, 3 StopTimeUpdates are provided:
+ // - delay of 5 min for stop_sequence 3
+ // - delay of 1 min for stop_sequence 8
+ // - delay of unspecified duration for stop_sequence 10
+ // This will be interpreted as:
+ // - stop_sequences 3,4,5,6,7 have delay of 5 min.
+ // - stop_sequences 8,9 have delay of 1 min.
+ // - stop_sequences 10,... have unknown delay.
+ repeated StopTimeUpdate stop_time_update = 2;
+}
+
+// Realtime positioning information for a given vehicle.
+message VehiclePosition {
+ // The Trip that this vehicle is serving.
+ // Can be empty or partial if the vehicle can not be identified with a given
+ // trip instance.
+ optional TripDescriptor trip = 1;
+
+ // Additional information on the vehicle that is serving this trip.
+ optional VehicleDescriptor vehicle = 8;
+
+ // Current position of this vehicle.
+ optional Position position = 2;
+
+ // The stop sequence index of the current stop. The meaning of
+ // current_stop_sequence (i.e., the stop that it refers to) is determined by
+ // current_status.
+ // If current_status is missing IN_TRANSIT_TO is assumed.
+ optional uint32 current_stop_sequence = 3;
+ // Identifies the current stop. The value must be the same as in stops.txt in
+ // the corresponding GTFS feed.
+ optional string stop_id = 7;
+
+ enum VehicleStopStatus {
+ // The vehicle is just about to arrive at the stop (on a stop
+ // display, the vehicle symbol typically flashes).
+ INCOMING_AT = 0;
+
+ // The vehicle is standing at the stop.
+ STOPPED_AT = 1;
+
+ // The vehicle has departed and is in transit to the next stop.
+ IN_TRANSIT_TO = 2;
+ }
+ // The exact status of the vehicle with respect to the current stop.
+ // Ignored if current_stop_sequence is missing.
+ optional VehicleStopStatus current_status = 4 [default = IN_TRANSIT_TO];
+
+ // Moment at which the vehicle's position was measured. In POSIX time
+ // (i.e., number of seconds since January 1st 1970 00:00:00 UTC).
+ optional uint64 timestamp = 5;
+
+ // Congestion level that is affecting this vehicle.
+ enum CongestionLevel {
+ UNKNOWN_CONGESTION_LEVEL = 0;
+ RUNNING_SMOOTHLY = 1;
+ STOP_AND_GO = 2;
+ CONGESTION = 3;
+ SEVERE_CONGESTION = 4; // People leaving their cars.
+ }
+ optional CongestionLevel congestion_level = 6;
+}
+
+// An alert, indicating some sort of incident in the public transit network.
+message Alert {
+ // Time when the alert should be shown to the user. If missing, the
+ // alert will be shown as long as it appears in the feed.
+ // If multiple ranges are given, the alert will be shown during all of them.
+ repeated TimeRange active_period = 1;
+
+ // Entities whose users we should notify of this alert.
+ repeated EntitySelector informed_entity = 5;
+
+ // Cause of this alert.
+ enum Cause {
+ UNKNOWN_CAUSE = 1;
+ OTHER_CAUSE = 2; // Not machine-representable.
+ TECHNICAL_PROBLEM = 3;
+ STRIKE = 4; // Public transit agency employees stopped working.
+ DEMONSTRATION = 5; // People are blocking the streets.
+ ACCIDENT = 6;
+ HOLIDAY = 7;
+ WEATHER = 8;
+ MAINTENANCE = 9;
+ CONSTRUCTION = 10;
+ POLICE_ACTIVITY = 11;
+ MEDICAL_EMERGENCY = 12;
+ }
+ optional Cause cause = 6 [default = UNKNOWN_CAUSE];
+
+ // What is the effect of this problem on the affected entity.
+ enum Effect {
+ NO_SERVICE = 1;
+ REDUCED_SERVICE = 2;
+
+ // We don't care about INsignificant delays: they are hard to detect, have
+ // little impact on the user, and would clutter the results as they are too
+ // frequent.
+ SIGNIFICANT_DELAYS = 3;
+
+ DETOUR = 4;
+ ADDITIONAL_SERVICE = 5;
+ MODIFIED_SERVICE = 6;
+ OTHER_EFFECT = 7;
+ UNKNOWN_EFFECT = 8;
+ STOP_MOVED = 9;
+ }
+ optional Effect effect = 7 [default = UNKNOWN_EFFECT];
+
+ // The URL which provides additional information about the alert.
+ optional TranslatedString url = 8;
+
+ // Alert header. Contains a short summary of the alert text.
+ optional TranslatedString header_text = 10;
+
+ // Full description for the alert. The information in the description
+ // should add to the information of the header.
+ optional TranslatedString description_text = 11;
+}
+
+//
+// Low level data structures used above.
+//
+
+// A time interval.
+message TimeRange {
+ // Start time, in POSIX time (i.e., number of seconds since January 1st 1970
+ // 00:00:00 UTC).
+ // If missing, the interval starts at minus infinity.
+ optional uint64 start = 1;
+
+ // End time, in POSIX time (i.e., number of seconds since January 1st 1970
+ // 00:00:00 UTC).
+ // If missing, the interval ends at plus infinity.
+ optional uint64 end = 2;
+}
+
+// A position.
+message Position {
+ // Degrees North, in the WGS-84 coordinate system.
+ required float latitude = 1;
+
+ // Degrees East, in the WGS-84 coordinate system.
+ required float longitude = 2;
+
+ // Bearing, in degrees, clockwise from North, i.e., 0 is North and 90 is East.
+ // This can be the compass bearing, or the direction towards the next stop
+ // or intermediate location.
+ // This should not be direction deduced from the sequence of previous
+ // positions, which can be computed from previous data.
+ optional float bearing = 3;
+
+ // Odometer value, in meters.
+ optional double odometer = 4;
+ // Momentary speed measured by the vehicle, in meters per second.
+ optional float speed = 5;
+
+}
+
+// A descriptor that identifies an instance of a GTFS trip, or all instances of
+// a trip along a route.
+// - To specify a single trip instance, the trip_id (and if necessary,
+// start_time) is set. If route_id is also set, then it should be same as one
+// that the given trip corresponds to.
+// - To specify all the trips along a given route, only the route_id should be
+// set. Note that if the trip_id is not known, then stop sequence ids in
+// TripUpdate are not sufficient, and stop_ids must be provided as well. In
+// addition, absolute arrival/departure times must be provided.
+message TripDescriptor {
+ // The trip_id from the GTFS feed that this selector refers to.
+ // For non frequency expanded trips, this field is enough to uniquely identify
+ // the trip. For frequency expanded, start_time and start_date might also be
+ // necessary.
+ optional string trip_id = 1;
+
+ // The route_id from the GTFS that this selector refers to.
+ optional string route_id = 5;
+
+ // The scheduled start time of this trip instance.
+ // This field should be given only if the trip is frequency-expanded in the
+ // GTFS feed. The value must precisely correspond to start_time specified for
+ // the route in the GTFS feed plus some multiple of headway_secs.
+ // Format of the field is same as that of GTFS/frequencies.txt/start_time,
+ // e.g., 11:15:35 or 25:15:35.
+ optional string start_time = 2;
+
+ // The scheduled start date of this trip instance.
+ // Must be provided to disambiguate trips that are so late as to collide with
+ // a scheduled trip on a next day. For example, for a train that departs 8:00
+ // and 20:00 every day, and is 12 hours late, there would be two distinct
+ // trips on the same time.
+ // This field can be provided but is not mandatory for schedules in which such
+ // collisions are impossible - for example, a service running on hourly
+ // schedule where a vehicle that is one hour late is not considered to be
+ // related to schedule anymore.
+ // In YYYYMMDD format.
+ optional string start_date = 3;
+
+ // The relation between this trip and the static schedule. If a trip is done
+ // in accordance with temporary schedule, not reflected in GTFS, then it
+ // shouldn't be marked as SCHEDULED, but likely as ADDED.
+ enum ScheduleRelationship {
+ // Trip that is running in accordance with its GTFS schedule, or is close
+ // enough to the scheduled trip to be associated with it.
+ SCHEDULED = 0;
+
+ // An extra trip that was added in addition to a running schedule, for
+ // example, to replace a broken vehicle or to respond to sudden passenger
+ // load.
+ ADDED = 1;
+
+ // A trip that is running with no schedule associated to it, for example, if
+ // there is no schedule at all.
+ UNSCHEDULED = 2;
+
+ // A trip that existed in the schedule but was removed.
+ CANCELED = 3;
+
+ // A trip that replaces a portion of static schedule.
+ // If the trip selector identifies a certain trip instance, then only that
+ // instance is replaced. If the selector identifies a route, then all the
+ // trips along that route are replaced.
+ //
+ // The replacement applies only to the portion of the trip supplied. For
+ // instance, consider a route that goes through stops A,B,C,D,E,F, and a
+ // REPLACEMENT trip provides data for stops A,B,C. Then, the times for stops
+ // D,E,F are still taken from the static schedule.
+ //
+ // A feed might supply several REPLACEMENT trips. In this case, the portion
+ // of static schedule that is replaced is the union of what is defined by
+ // all the feeds. Normally, all the REPLACEMENT trips should either
+ // correspond to the same route or to individual trip instances.
+ REPLACEMENT = 5;
+ }
+ optional ScheduleRelationship schedule_relationship = 4;
+}
+
+// Identification information for the vehicle performing the trip.
+message VehicleDescriptor {
+ // Internal system identification of the vehicle. Should be unique per
+ // vehicle, and can be used for tracking the vehicle as it proceeds through
+ // the system.
+ optional string id = 1;
+
+ // User visible label, i.e., something that must be shown to the passenger to
+ // help identify the correct vehicle.
+ optional string label = 2;
+
+ // The license plate of the vehicle.
+ optional string license_plate = 3;
+}
+
+// A selector for an entity in a GTFS feed.
+message EntitySelector {
+ // The values of the fields should correspond to the appropriate fields in the
+ // GTFS feed.
+ // At least one specifier must be given. If several are given, then the
+ // matching has to apply to all the given specifiers.
+ optional string agency_id = 1;
+ optional string route_id = 2;
+ // corresponds to route_type in GTFS.
+ optional int32 route_type = 3;
+ optional TripDescriptor trip = 4;
+ optional string stop_id = 5;
+}
+
+// An internationalized message containing per-language versions of a snippet of
+// text or a URL.
+// One of the strings from a message will be picked up. The resolution proceeds
+// as follows:
+// 1. If the UI language matches the language code of a translation,
+// the first matching translation is picked.
+// 2. If a default UI language (e.g., English) matches the language code of a
+// translation, the first matching translation is picked.
+// 3. If some translation has an unspecified language code, that translation is
+// picked.
+message TranslatedString {
+ message Translation {
+ // A UTF-8 string containing the message.
+ required string text = 1;
+ // BCP-47 language code. Can be omitted if the language is unknown or if
+ // no i18n is done at all for the feed. At most one translation is
+ // allowed to have an unspecified language tag.
+ optional string language = 2;
+ }
+ // At least one translation must be provided.
+ repeated Translation translation = 1;
+}
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf.php
@@ -1,1 +1,167 @@
+<?php
+namespace DrSlump;
+
+use DrSlump\Protobuf;
+
+class Protobuf
+{
+ const VERSION = '@package_version@';
+
+ const RULE_OPTIONAL = 1;
+ const RULE_REQUIRED = 2;
+ const RULE_REPEATED = 3;
+ const RULE_UNKNOWN = -1;
+
+ const TYPE_DOUBLE = 1;
+ const TYPE_FLOAT = 2;
+ const TYPE_INT64 = 3;
+ const TYPE_UINT64 = 4;
+ const TYPE_INT32 = 5;
+ const TYPE_FIXED64 = 6;
+ const TYPE_FIXED32 = 7;
+ const TYPE_BOOL = 8;
+ const TYPE_STRING = 9;
+ const TYPE_GROUP = 10;
+ const TYPE_MESSAGE = 11;
+ const TYPE_BYTES = 12;
+ const TYPE_UINT32 = 13;
+ const TYPE_ENUM = 14;
+ const TYPE_SFIXED32 = 15;
+ const TYPE_SFIXED64 = 16;
+ const TYPE_SINT32 = 17;
+ const TYPE_SINT64 = 18;
+ const TYPE_UNKNOWN = -1;
+
+
+ static protected $codecs = array();
+
+
+ /**
+ * Setup SPL autoloader for Protobuf library classes
+ *
+ * @static
+ * @return void
+ */
+ static public function autoload()
+ {
+ spl_autoload_register(function($class){
+ $prefix = __CLASS__ . '\\';
+ if (strpos($class, $prefix) === 0) {
+ // Remove vendor from name
+ $class = substr($class, strlen(__NAMESPACE__)+1);
+ // Convert namespace separator to directory ones
+ $class = str_replace('\\', DIRECTORY_SEPARATOR, $class);
+ // Prefix with this file's directory
+ $class = __DIR__ . DIRECTORY_SEPARATOR . $class;
+
+ include($class . '.php');
+ return true;
+ }
+
+ return false;
+ });
+ }
+
+ /**
+ * Obtain an instance of the descriptor's registry
+ *
+ * @static
+ * @return Protobuf\Registry
+ */
+ static public function getRegistry()
+ {
+ static $registry = NULL;
+
+ if (NULL === $registry) {
+ $registry = new Protobuf\Registry();
+ }
+
+ return $registry;
+ }
+
+
+ static public function getCodec($codec = null)
+ {
+ if ($codec instanceof Protobuf\CodecInterface) {
+ return $codec;
+ }
+
+ // Bootstrap the library's default codec if none is available
+ if (!isset(self::$codecs['default'])) {
+ $default = new Protobuf\Codec\Binary();
+ self::registerCodec('default', $default);
+ self::registerCodec('binary', $default);
+ }
+
+ if (is_string($codec)) {
+ $codec = strtolower($codec);
+ if (!isset(self::$codecs[$codec])) {
+ throw new Protobuf\Exception('No codec found by name "' . $codec . '"');
+ }
+ return self::$codecs[$codec];
+ }
+
+ return self::getCodec('default');
+ }
+
+ static public function setDefaultCodec($codec)
+ {
+ if (is_string($codec)) {
+ $codec = self::getCodec($codec);
+ }
+
+ if ($codec instanceof Protobuf\CodecInterface) {
+ self::registerCodec('default', $codec);
+ } else {
+ throw new Protobuf\Exception('Codec must implement DrSlump\Protobuf\CodecInterface');
+ }
+ }
+
+ static public function registerCodec($name, Protobuf\CodecInterface $codec)
+ {
+ $name = strtolower($name);
+ self::$codecs[$name] = $codec;
+ }
+
+ static public function unregisterCodec($name)
+ {
+ $name = strtolower($name);
+ if (isset(self::$codecs[$name])) {
+ unset(self::$codecs[$name]);
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Encodes a message using the default codec
+ *
+ * @static
+ * @param \DrSlump\Protobuf\Message $message
+ * @return string
+ */
+ static public function encode(Protobuf\Message $message)
+ {
+ $codec = self::getCodec();
+ return $codec->encode($message);
+ }
+
+ /**
+ * @static
+ * @param String|Message $message
+ * @param String $data
+ * @return \DrSlump\Protobuf\Message
+ */
+ static public function decode($message, $data)
+ {
+ if (is_string($message)) {
+ $message = '\\' . ltrim($message, '\\');
+ $message = new $message;
+ }
+
+ $codec = self::getCodec();
+ return $codec->decode($message, $data);
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/AnnotatedMessage.php
@@ -1,1 +1,116 @@
+<?php
+namespace DrSlump\Protobuf;
+
+use DrSlump\Protobuf;
+
+abstract class AnnotatedMessage extends Message
+{
+ static public function descriptor()
+ {
+ $class = get_called_class();
+
+ // Instantiate a new descriptor
+ $descriptor = new Descriptor($class);
+
+ $rflClass = new \ReflectionClass($class);
+ $props = $rflClass->getProperties();
+ foreach ($props as $prop) {
+ $doc = $prop->getDocComment();
+ if (empty($doc)) {
+ continue;
+ }
+
+ // Format: @protobuf(tag=X, type=bool, required=true)
+
+ // Extract annotation from the comment
+ if (!preg_match('/@protobuf\s?\(([^\)]+)\)/', $doc, $m)) {
+ continue;
+ }
+
+ // Parse params
+ $params = explode(',', $m[1]);
+ $params = array_filter(array_map('trim', $params));
+
+ $options = array();
+ foreach ($params as $param) {
+ $parts = explode('=', $param);
+ $parts = array_filter(array_map('trim', $parts));
+ $options[$parts[0]] = count($parts) < 2
+ ? true
+ : $parts[1];
+ }
+
+ // Check if we have the minimum required options
+ if (empty($options['tag'])) {
+ throw new \InvalidArgumentException('The tag option is required for property ' . $prop->getName());
+ }
+ if (empty($options['type'])) {
+ throw new \InvalidArgumentException('The type option is required for property ' . $prop->getName());
+ }
+
+ // Normalize boolean values
+ foreach(array('required', 'optional', 'repeated', 'packed') as $opt) {
+ if (isset($options[$opt])) {
+ $options[$opt] = filter_var($options[$opt], FILTER_VALIDATE_BOOLEAN);
+ }
+ }
+
+ // Build a field descriptor
+ $f = new Protobuf\Field();
+ $f->number = (int)$options['tag'];
+ $f->name = $prop->getName();
+
+ // Convert type name to its numeric constant
+ switch (strtolower($options['type'])) {
+ case 'double' : $f->type = Protobuf::TYPE_DOUBLE; break;
+ case 'float' : $f->type = Protobuf::TYPE_FLOAT; break;
+ case 'int64' : $f->type = Protobuf::TYPE_INT64; break;
+ case 'uint64' : $f->type = Protobuf::TYPE_UINT64; break;
+ case 'int32' : $f->type = Protobuf::TYPE_INT32; break;
+ case 'fixed64' : $f->type = Protobuf::TYPE_FIXED64; break;
+ case 'fixed32' : $f->type = Protobuf::TYPE_FIXED32; break;
+ case 'bool' : $f->type = Protobuf::TYPE_BOOL; break;
+ case 'string' : $f->type = Protobuf::TYPE_STRING; break;
+ case 'message' : $f->type = Protobuf::TYPE_MESSAGE; break;
+ case 'bytes' : $f->type = Protobuf::TYPE_BYTES; break;
+ case 'uint32' : $f->type = Protobuf::TYPE_UINT32; break;
+ case 'enum' : $f->type = Protobuf::TYPE_ENUM; break;
+ case 'sfixed32': $f->type = Protobuf::TYPE_SFIXED32; break;
+ case 'sfixed64': $f->type = Protobuf::TYPE_SFIXED64; break;
+ case 'sint32' : $f->type = Protobuf::TYPE_SINT32; break;
+ case 'sint64' : $f->type = Protobuf::TYPE_SINT64; break;
+ default:
+ throw new \InvalidArgumentException('Type ' . $options['type'] . ' is not recognized as valid for property ' . $prop->getName());
+ }
+
+ // Define the rule type
+ $f->rule = Protobuf::RULE_OPTIONAL;
+ if (!empty($options['required'])) $f->rule = Protobuf::RULE_REQUIRED;
+ if (!empty($options['repeated'])) $f->rule = Protobuf::RULE_REPEATED;
+
+ // Check if it's flagged as packed
+ if (isset($options['packed'])) {
+ $f->packed = $options['packed'];
+ }
+
+ // Get the reference
+ if (isset($options['reference'])) {
+ $f->reference = $options['reference'];
+ } else if ($f->type === Protobuf::TYPE_MESSAGE || $f->type === Protobuf::TYPE_ENUM) {
+ throw new \InvalidArgumentException('Property ' . $prop->getName() . ' requires the "reference" option');
+ }
+
+ if (isset($options['default'])) {
+ $f->default = $options['default'];
+ }
+
+ // Add the field to the message descriptor
+ $descriptor->addField($f);
+ }
+
+ return $descriptor;
+ }
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/Binary.php
@@ -1,1 +1,389 @@
-
+<?php
+
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+class Binary implements Protobuf\CodecInterface
+{
+ const WIRE_VARINT = 0;
+ const WIRE_FIXED64 = 1;
+ const WIRE_LENGTH = 2;
+ const WIRE_GROUP_START = 3;
+ const WIRE_GROUP_END = 4;
+ const WIRE_FIXED32 = 5;
+ const WIRE_UNKNOWN = -1;
+
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @return string
+ */
+ public function encode(Protobuf\Message $message)
+ {
+ return $this->encodeMessage($message);
+ }
+
+ /**
+ * @param String|Message $message
+ * @param String $data
+ * @return \DrSlump\Protobuf\Message
+ */
+ public function decode(Protobuf\Message $message, $data)
+ {
+ return $this->decodeMessage($message, $data);
+ }
+
+
+ protected function encodeMessage(Protobuf\Message $message)
+ {
+ $writer = new Binary\Writer();
+
+ // Get message descriptor
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ foreach ($descriptor->getFields() as $tag=>$field) {
+
+ $empty = !$message->_has($tag);
+ if ($field->isRequired() && $empty) {
+ throw new \UnexpectedValueException(
+ 'Message ' . get_class($message) . '\'s field tag ' . $tag . '(' . $field->getName() . ') is required but has no value'
+ );
+ }
+
+ // Skip empty fields
+ if ($empty) {
+ continue;
+ }
+
+ $type = $field->getType();
+ $wire = $field->isPacked() ? self::WIRE_LENGTH : $this->getWireType($type, null);
+
+ // Compute key with tag number and wire type
+ $key = $tag << 3 | $wire;
+
+ $value = $message->_get($tag);
+
+ if ($field->isRepeated()) {
+
+ // Packed fields are encoded as a length-delimited stream containing
+ // the concatenated encoding of each value.
+ if ($field->isPacked() && !empty($value)) {
+ $subwriter = new Binary\Writer();
+ foreach($value as $val) {
+ $this->encodeSimpleType($subwriter, $type, $val);
+ }
+ $data = $subwriter->getBytes();
+ $writer->varint($key);
+ $writer->varint(strlen($data));
+ $writer->write($data);
+ } else {
+ foreach($value as $val) {
+ if ($type !== Protobuf::TYPE_MESSAGE) {
+ $writer->varint($key);
+ $this->encodeSimpleType($writer, $type, $val);
+ } else {
+ $writer->varint($key);
+ $data = $this->encodeMessage($val);
+ $writer->varint(strlen($data));
+ $writer->write($data);
+ }
+ }
+ }
+ } else {
+ if ($type !== Protobuf::TYPE_MESSAGE) {
+ $writer->varint($key);
+ $this->encodeSimpleType($writer, $type, $value);
+ } else {
+ $writer->varint($key);
+ $data = $this->encodeMessage($value);
+ $writer->varint(strlen($data));
+ $writer->write($data);
+ }
+ }
+ }
+
+ return $writer->getBytes();
+ }
+
+ protected function encodeSimpleType($writer, $type, $value)
+ {
+ switch ($type) {
+ case Protobuf::TYPE_INT32:
+ case Protobuf::TYPE_INT64:
+ case Protobuf::TYPE_UINT64:
+ case Protobuf::TYPE_UINT32:
+ $writer->varint($value);
+ break;
+
+ case Protobuf::TYPE_SINT32: // ZigZag
+ $writer->zigzag($value, 32);
+ break;
+
+ case Protobuf::TYPE_SINT64 : // ZigZag
+ $writer->zigzag($value, 64);
+ break;
+
+ case Protobuf::TYPE_DOUBLE:
+ $writer->double($value);
+ break;
+ case Protobuf::TYPE_FIXED64:
+ $writer->fixed64($value);
+ break;
+ case Protobuf::TYPE_SFIXED64:
+ $writer->sFixed64($value);
+ break;
+
+ case Protobuf::TYPE_FLOAT:
+ $writer->float($value);
+ break;
+ case Protobuf::TYPE_FIXED32:
+ $writer->fixed32($value);
+ break;
+ case Protobuf::TYPE_SFIXED32:
+ $writer->sFixed32($value);
+ break;
+
+ case Protobuf::TYPE_BOOL:
+ $writer->varint($value ? 1 : 0);
+ break;
+
+ case Protobuf::TYPE_STRING:
+ case Protobuf::TYPE_BYTES:
+ $writer->varint(strlen($value));
+ $writer->write($value);
+ break;
+
+ case Protobuf::TYPE_MESSAGE:
+ // Messages are not supported in this method
+ return null;
+
+ case Protobuf::TYPE_ENUM:
+ $writer->varint($value);
+ break;
+
+ default:
+ throw new \Exception('Unknown field type ' . $type);
+ }
+ }
+
+
+ protected function decodeMessage(\DrSlump\Protobuf\Message $message, $data)
+ {
+ /** @var $message \DrSlump\Protobuf\Message */
+ /** @var $descriptor \DrSlump\Protobuf\Descriptor */
+
+ // Create a binary reader for the data
+ $reader = new Protobuf\Codec\Binary\Reader($data);
+
+ // Get message descriptor
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ while (!$reader->eof()) {
+
+ // Get initial varint with tag number and wire type
+ $key = $reader->varint();
+ if ($reader->eof()) break;
+
+ $wire = $key & 0x7;
+ $tag = $key >> 3;
+
+ // Find the matching field for the tag number
+ $field = $descriptor->getField($tag);
+ if (!$field) {
+ $data = $this->decodeUnknown($reader, $wire);
+ $unknown = new Binary\Unknown($tag, $wire, $data);
+ $message->addUnknown($unknown);
+ continue;
+ }
+
+ $type = $field->getType();
+
+ // Check if we are dealing with a packed stream, we cannot rely on the packed
+ // flag of the message since we cannot be certain if the creator of the message
+ // was using it.
+ if ($wire === self::WIRE_LENGTH && $field->isRepeated() && $this->isPackable($type)) {
+ $length = $reader->varint();
+ $until = $reader->pos() + $length;
+ while ($reader->pos() < $until) {
+ $item = $this->decodeSimpleType($reader, $type, self::WIRE_VARINT);
+ $message->_add($tag, $item);
+ }
+
+ } else {
+
+ // Assert wire and type match
+ $this->assertWireType($wire, $type);
+
+ // Check if it's a sub-message
+ if ($type === Protobuf::TYPE_MESSAGE) {
+ $submessage = $field->getReference();
+ $submessage = new $submessage;
+
+ $length = $this->decodeSimpleType($reader, Protobuf::TYPE_INT64, self::WIRE_VARINT);
+ $data = $reader->read($length);
+
+ $value = $this->decodeMessage($submessage, $data);
+ } else {
+ $value = $this->decodeSimpleType($reader, $type, $wire);
+ }
+
+ // Support non-packed repeated fields
+ if ($field->isRepeated()) {
+ $message->_add($tag, $value);
+ } else {
+ $message->_set($tag, $value);
+ }
+ }
+ }
+
+ return $message;
+ }
+
+ protected function isPackable($type)
+ {
+ static $packable = array(
+ Protobuf::TYPE_INT64,
+ Protobuf::TYPE_UINT64,
+ Protobuf::TYPE_INT32,
+ Protobuf::TYPE_UINT32,
+ Protobuf::TYPE_SINT32,
+ Protobuf::TYPE_SINT64,
+ Protobuf::TYPE_DOUBLE,
+ Protobuf::TYPE_FIXED64,
+ Protobuf::TYPE_SFIXED64,
+ Protobuf::TYPE_FLOAT,
+ Protobuf::TYPE_FIXED32,
+ Protobuf::TYPE_SFIXED32,
+ Protobuf::TYPE_BOOL,
+ Protobuf::TYPE_ENUM
+ );
+
+ return in_array($type, $packable);
+ }
+
+ protected function decodeUnknown($reader, $wire)
+ {
+ switch ($wire) {
+ case self::WIRE_VARINT:
+ return $reader->varint();
+ case self::WIRE_LENGTH:
+ $length = $reader->varint();
+ return $reader->read($length);
+ case self::WIRE_FIXED32:
+ return $reader->fixed32();
+ case self::WIRE_FIXED64:
+ return $reader->fixed64();
+ case self::WIRE_GROUP_START:
+ case self::WIRE_GROUP_END:
+ throw new \RuntimeException('Groups are deprecated in Protocol Buffers and unsupported by this library');
+ default:
+ throw new \RuntimeException('Unsupported wire type (' . $wire . ') while consuming unknown field');
+ }
+ }
+
+ protected function assertWireType($wire, $type)
+ {
+ $expected = $this->getWireType($type, $wire);
+ if ($wire !== $expected) {
+ throw new \RuntimeException("Expected wire type $expected but got $wire for type $type");
+ }
+ }
+
+ protected function getWireType($type, $default)
+ {
+ switch ($type) {
+ case Protobuf::TYPE_INT32:
+ case Protobuf::TYPE_INT64:
+ case Protobuf::TYPE_UINT32:
+ case Protobuf::TYPE_UINT64:
+ case Protobuf::TYPE_SINT32:
+ case Protobuf::TYPE_SINT64:
+ case Protobuf::TYPE_BOOL:
+ case Protobuf::TYPE_ENUM:
+ return self::WIRE_VARINT;
+ case Protobuf::TYPE_FIXED64:
+ case Protobuf::TYPE_SFIXED64:
+ case Protobuf::TYPE_DOUBLE:
+ return self::WIRE_FIXED64;
+ case Protobuf::TYPE_STRING:
+ case Protobuf::TYPE_BYTES:
+ case Protobuf::TYPE_MESSAGE:
+ return self::WIRE_LENGTH;
+ case Protobuf::TYPE_FIXED32:
+ case Protobuf::TYPE_SFIXED32:
+ case Protobuf::TYPE_FLOAT:
+ return self::WIRE_FIXED32;
+ default:
+ // Unknown fields just return the reported wire type
+ return $default;
+ }
+ }
+
+ protected function decodeSimpleType($reader, $type, $wireType)
+ {
+ switch ($type) {
+ case Protobuf::TYPE_INT64:
+ case Protobuf::TYPE_UINT64:
+ case Protobuf::TYPE_INT32:
+ case Protobuf::TYPE_UINT32:
+ return $reader->varint();
+
+ case Protobuf::TYPE_SINT32: // ZigZag
+ return $reader->zigzag();
+ case Protobuf::TYPE_SINT64: // ZigZag
+ return $reader->zigzag();
+ case Protobuf::TYPE_DOUBLE:
+ return $reader->double();
+ case Protobuf::TYPE_FIXED64:
+ return $reader->fixed64();
+ case Protobuf::TYPE_SFIXED64:
+ return $reader->sFixed64();
+
+ case Protobuf::TYPE_FLOAT:
+ return $reader->float();
+ case Protobuf::TYPE_FIXED32:
+ return $reader->fixed32();
+ case Protobuf::TYPE_SFIXED32:
+ return $reader->sFixed32();
+
+ case Protobuf::TYPE_BOOL:
+ return (bool)$reader->varint();
+
+ case Protobuf::TYPE_STRING:
+ $length = $reader->varint();
+ return $reader->read($length);
+
+ case Protobuf::TYPE_MESSAGE:
+ // Messages are not supported in this method
+ return null;
+
+ case Protobuf::TYPE_BYTES:
+ $length = $reader->varint();
+ return $reader->read($length);
+
+ case Protobuf::TYPE_ENUM:
+ return $reader->varint();
+
+ default:
+ // Unknown type, follow wire type rules
+ switch ($wireType) {
+ case self::WIRE_VARINT:
+ return $reader->varint();
+ case self::WIRE_FIXED32:
+ return $reader->fixed32();
+ case self::WIRE_FIXED64:
+ return $reader->fixed64();
+ case self::WIRE_LENGTH:
+ $length = $reader->varint();
+ return $reader->read($length);
+ case self::WIRE_GROUP_START:
+ case self::WIRE_GROUP_END:
+ throw new \RuntimeException('Group is deprecated and not supported');
+ default:
+ throw new \RuntimeException('Unsupported wire type number ' . $wireType);
+ }
+ }
+
+ }
+
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/Binary/Reader.php
@@ -1,1 +1,223 @@
-
+<?php
+
+namespace DrSlump\Protobuf\Codec\Binary;
+
+/**
+ * Implements reading primitives for Protobuf binary streams
+ *
+ * Important: There are no checks in place for overflows, so you must
+ * be aware of PHP's integer and floating point limits.
+ *
+ * @note Protobuf uses little-endian order
+ */
+class Reader
+{
+ /** @var resource */
+ protected $_fd;
+
+ /**
+ * Create a new reader from a file descriptor or a string of bytes
+ *
+ * @param resource|string $fdOrString
+ */
+ public function __construct($fdOrString)
+ {
+ if (is_resource($fdOrString)) {
+ $this->_fd = $fdOrString;
+ } else {
+ // @todo Could this be faster by using a custom String wrapper?
+ $this->_fd = fopen('data://text/plain,' . urlencode($fdOrString), 'rb');
+ }
+ }
+
+ public function __destruct()
+ {
+ fclose($this->_fd);
+ }
+
+ /**
+ * Obtain a number of bytes from the string
+ *
+ * @throws \RuntimeException
+ * @param int $length
+ * @return string
+ */
+ public function read($length)
+ {
+ // Protect against 0 byte reads when an EOF
+ if ($length < 1) return '';
+
+ $bytes = fread($this->_fd, $length);
+ if (FALSE === $bytes) {
+ throw new \RuntimeException('Failed to read ' . $length . ' bytes');
+ }
+
+ return $bytes;
+ }
+
+ /**
+ * Check if we have reached the end of the stream
+ *
+ * @return bool
+ */
+ public function eof()
+ {
+ return feof($this->_fd);
+ }
+
+ /**
+ * Obtain the current position in the stream
+ *
+ * @return int
+ */
+ public function pos()
+ {
+ return ftell($this->_fd);
+ }
+
+ /**
+ * Obtain a byte
+ *
+ * @return int
+ */
+ public function byte()
+ {
+ return ord($this->read(1));
+ }
+
+ /**
+ * Decode a varint
+ *
+ * @return int
+ */
+ public function varint()
+ {
+ $result = $shift = 0;
+ do {
+ $byte = $this->byte();
+ $result |= ($byte & 0x7f) << $shift;
+ $shift += 7;
+ } while ($byte > 0x7f);
+
+ return $result;
+ }
+
+ /**
+ * Decodes a zigzag integer of the given bits
+ *
+ * @param int $bits - Either 32 or 64
+ */
+ public function zigzag()
+ {
+ $number = $this->varint();
+ return ($number >> 1) ^ (-($number & 1));
+ }
+
+ /**
+ * Decode a fixed 32bit integer with sign
+ *
+ * @return int
+ */
+ public function sFixed32()
+ {
+ $bytes = $this->read(4);
+ if ($this->isBigEndian()) {
+ $bytes = strrev($bytes);
+ }
+
+ list(, $result) = unpack('l', $bytes);
+ return $result;
+ }
+
+ /**
+ * Decode a fixed 32bit integer without sign
+ *
+ * @return int
+ */
+ public function fixed32()
+ {
+ $bytes = $this->read(4);
+
+ if (PHP_INT_SIZE < 8) {
+ list(, $lo, $hi) = unpack('v*', $bytes);
+ $result = $hi << 16 | $lo;
+ } else {
+ list(, $result) = unpack('V*', $bytes);
+ }
+
+ return $result;
+ }
+
+ /**
+ * Decode a fixed 62bit integer with sign
+ *
+ * @return int
+ */
+ public function sFixed64()
+ {
+ $bytes = $this->read(8);
+
+ list(, $lo0, $lo1, $hi0, $hi1) = unpack('v*', $bytes);
+ return ($hi1 << 16 | $hi0) << 32 | ($lo1 << 16 | $lo0);
+ }
+
+ /**
+ * Decode a fixed 62bit integer without sign
+ *
+ * @return int
+ */
+ public function fixed64()
+ {
+ return $this->sFixed64();
+ }
+
+ /**
+ * Decode a 32bit float
+ *
+ * @return float
+ */
+ public function float()
+ {
+ $bytes = $this->read(4);
+ if ($this->isBigEndian()) {
+ $bytes = strrev($bytes);
+ }
+
+ list(, $result) = unpack('f', $bytes);
+ return $result;
+ }
+
+ /**
+ * Decode a 64bit double
+ *
+ * @return float
+ */
+ public function double()
+ {
+ $bytes = $this->read(8);
+ if ($this->isBigEndian()) {
+ $bytes = strrev($bytes);
+ }
+
+ list(, $result) = unpack('d', $bytes);
+ return $result;
+ }
+
+ /**
+ * Check if the current architecture is Big Endian
+ *
+ * @return bool
+ */
+ public function isBigEndian()
+ {
+ static $endianness;
+
+ if (NULL === $endianness) {
+ list(,$result) = unpack('L', pack('V', 1));
+ $endianness = $result !== 1;
+ }
+
+ return $endianness;
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/Binary/Unknown.php
@@ -1,1 +1,14 @@
+<?php
+namespace DrSlump\Protobuf\Codec\Binary;
+
+class Unknown extends \DrSlump\Protobuf\Unknown
+{
+ public function __construct($tag, $type, $data)
+ {
+ $this->tag = $tag;
+ $this->type = $type;
+ $this->data = $data;
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/Binary/Writer.php
@@ -1,1 +1,318 @@
-
+<?php
+
+namespace DrSlump\Protobuf\Codec\Binary;
+
+/**
+ * Implements writing primitives for Protobuf binary streams
+ *
+ * @note Protobuf uses little-endian order
+ */
+class Writer
+{
+ /** @var resource */
+ protected $_fd;
+
+
+ public function __construct()
+ {
+ $this->_fd = fopen('php://memory', 'wb');
+ }
+
+ public function __destruct()
+ {
+ fclose($this->_fd);
+ }
+
+ /**
+ * Get the current bytes in the stream
+ *
+ * @return string
+ */
+ public function getBytes()
+ {
+ fseek($this->_fd, 0, SEEK_SET);
+ return stream_get_contents($this->_fd);
+ }
+
+ /**
+ * Store the given bytes in the stream
+ *
+ * @throws \RuntimeException
+ * @param string $bytes
+ * @param int $length
+ */
+ public function write($bytes, $length = null)
+ {
+ if ($length === NULL) {
+ $length = strlen($bytes);
+ }
+
+ $written = fwrite($this->_fd, $bytes, $length);
+ if ($written !== $length) {
+ throw new \RuntimeException('Failed to write ' . $length . ' bytes');
+ }
+ }
+
+ /**
+ * Store a single byte
+ *
+ * @param int $value
+ */
+ public function byte($value)
+ {
+ $this->write(chr($value), 1);
+ }
+
+ /**
+ * Store an integer encoded as varint
+ *
+ * @throws \OutOfBoundsException
+ * @param int $value
+ */
+ public function varint($value)
+ {
+ // Small values do not need to be encoded
+ if ($value >= 0 && $value < 0x80) {
+ $this->byte($value);
+ return;
+ }
+
+ // Build an array of bytes with the encoded values
+ if ($value > 0) {
+ $values = array();
+ while ($value > 0) {
+ $values[] = 0x80 | ($value & 0x7f);
+ $value = $value >> 7;
+ }
+ } else if (function_exists('gmp_init')) {
+ $value = PHP_INT_SIZE < 8
+ ? gmp_and($value, '0x0ffffffffffffffff')
+ : sprintf('%u', $value);
+
+ $values = $this->varint_gmp($value);
+ } else if (PHP_INT_SIZE < 8) {
+ throw new \OutOfBoundsException(
+ "PHP versions compiled with 32bit integers can only support negative integer encoding with GMP extension ($value was given)"
+ );
+ } else if (function_exists('bccomp')) {
+ $value = sprintf('%u', $value);
+ $values = $this->varint_bc($value);
+ } else {
+ throw new \OutOfBoundsException("Varints of negative integers are only supported with GMP or BC big integers PHP extensions ($value was given)");
+ }
+
+ // Remove the MSB flag from the last byte
+ $values[count($values)-1] &= 0x7f;
+
+ // Convert the byte sized ints to actual bytes in a string
+ //$bytes = implode('', array_map('chr', $values));
+ $bytes = call_user_func_array('pack', array_merge(array('C*'), $values));;
+
+ $this->write($bytes);
+ }
+
+ public function varint_gmp($value)
+ {
+ static $x00, $x7f, $x80;
+
+ if (NULL === $x00) {
+ $x00 = \gmp_init(0x00);
+ $x7f = \gmp_init(0x7f);
+ $x80 = \gmp_init(0x80);
+ }
+
+ $values = array();
+ while (\gmp_cmp($value, $x00) > 0) {
+ $values[] = \gmp_intval(\gmp_and($value, $x7f)) | 0x80;
+ $value = \gmp_div_q($value, $x80);
+ }
+
+ return $values;
+ }
+
+ public function varint_bc($value)
+ {
+ $values = array();
+ while (\bccomp($value, 0, 0) > 0) {
+ // Get the last 7bits of the number
+ $bin = '';
+ $dec = $value;
+ do {
+ $rest = bcmod($dec, 2);
+ $dec = bcdiv($dec, 2, 0);
+ $bin = $rest . $bin;
+ } while ($dec > 0 && strlen($bin) < 7);
+
+ // Pack as a decimal and apply the flag
+ $values[] = intval($bin, 2) | 0x80;
+
+ $value = bcdiv($value, 0x80, 0);
+ }
+
+ return $values;
+ }
+
+ /**
+ * Encodes an integer with zigzag
+ *
+ * @param int $value
+ * @param int $base Either 32 or 64 bits
+ */
+ public function zigzag($value, $base = 32)
+ {
+ $value = ($value << 1) ^ ($value >> $base-1);
+ $this->varint($value);
+ }
+
+ /**
+ * Encode an integer as a fixed of 32bits with sign
+ *
+ * @param int $value
+ */
+ public function sFixed32($value)
+ {
+ $bytes = pack('l*', $value);
+ if ($this->isBigEndian()) {
+ $bytes = strrev($bytes);
+ }
+
+ $this->write($bytes, 4);
+ }
+
+ /**
+ * Encode an integer as a fixed of 32bits without sign
+ *
+ * @param int $value
+ */
+ public function fixed32($value)
+ {
+ $bytes = pack('V*', $value);
+ $this->write($bytes, 4);
+ }
+
+ /**
+ * Encode an integer as a fixed of 64bits with sign
+ *
+ * @param int $value
+ */
+ public function sFixed64($value)
+ {
+ if ($value >= 0) {
+ $this->fixed64($value);
+ } else if (function_exists('gmp_init')) {
+ $this->sFixed64_gmp($value);
+ } else if (function_exists('bcadd')) {
+ $this->sFixed64_bc($value);
+ } else {
+ throw new \OutOfBoundsException("The signed Fixed64 type with negative integers is only supported with GMP or BC big integers PHP extensions ($value was given)");
+ }
+ }
+
+ public function sFixed64_gmp($value)
+ {
+ static $xff, $x100;
+
+ if (NULL === $xff) {
+ $xff = gmp_init(0xff);
+ $x100 = gmp_init(0x100);
+ }
+
+ $value = PHP_INT_SIZE < 8
+ ? gmp_and($value, '0x0ffffffffffffffff')
+ : gmp_init(sprintf('%u', $value));
+
+ $bytes = '';
+ for ($i=0; $i<8; $i++) {
+ $bytes .= chr(gmp_intval(gmp_and($value, $xff)));
+ $value = gmp_div_q($value, $x100);
+ }
+
+ $this->write($bytes);
+ }
+
+ public function sFixed64_bc($value)
+ {
+ if (PHP_INT_SIZE < 8) {
+ throw new \OutOfBoundsException(
+ "PHP versions compiled with 32bit integers can only support negative integer encoding with GMP extension ($value was given)"
+ );
+ }
+
+ $value = sprintf('%u', $value);
+
+ $bytes = '';
+ for ($i=0; $i<8; $i++) {
+ // Get the last 8bits of the number
+ $bin = '';
+ $dec = $value;
+ do {
+ $bin = bcmod($dec, 2) . $bin;
+ $dec = bcdiv($dec, 2, 0);
+ } while (strlen($bin) < 8);
+
+ // Pack the byte
+ $bytes .= chr(intval($bin, 2));
+
+ $value = bcdiv($value, 0x100, 0);
+ }
+
+ $this->write($bytes);
+ }
+
+ /**
+ * Encode an integer as a fixed of 64bits without sign
+ *
+ * @param int $value
+ */
+ public function fixed64($value)
+ {
+ $bytes = pack('V*', $value & 0xffffffff, $value / (0xffffffff+1));
+ $this->write($bytes, 8);
+ }
+
+ /**
+ * Encode a number as a 32bit float
+ *
+ * @param float $value
+ */
+ public function float($value)
+ {
+ $bytes = pack('f*', $value);
+ if ($this->isBigEndian()) {
+ $bytes = strrev($bytes);
+ }
+ $this->write($bytes, 4);
+ }
+
+ /**
+ * Encode a number as a 64bit double
+ *
+ * @param float $value
+ */
+ public function double($value)
+ {
+ $bytes = pack('d*', $value);
+ if ($this->isBigEndian()) {
+ $bytes = strrev($bytes);
+ }
+ $this->write($bytes, 8);
+ }
+
+ /**
+ * Checks if the current architecture is Big Endian
+ *
+ * @return bool
+ */
+ public function isBigEndian()
+ {
+ static $endianness;
+
+ if (NULL === $endianness) {
+ list(,$result) = unpack('L', pack('V', 1));
+ $endianness = $result !== 1;
+ }
+
+ return $endianness;
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/Json.php
@@ -1,1 +1,39 @@
+<?php
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+/**
+ * This codec serializes and unserializes from/to Json strings
+ * where the keys represent the field's name.
+ *
+ * It makes use of the PhpArray codec to do the heavy work to just
+ * take care of converting the array to/from Json strings.
+ */
+class Json extends PhpArray
+ implements Protobuf\CodecInterface
+{
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @return string
+ */
+ public function encode(Protobuf\Message $message)
+ {
+ $data = $this->encodeMessage($message);
+ return json_encode($data);
+ }
+
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @param string $data
+ * @return \DrSlump\Protobuf\Message
+ */
+ public function decode(Protobuf\Message $message, $data)
+ {
+ $data = json_decode($data);
+ return $this->decodeMessage($message, $data);
+ }
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/JsonIndexed.php
@@ -1,1 +1,140 @@
+<?php
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+/**
+ * This codec serializes and unserializes from/to Json strings
+ * where the keys are packed as the first element of numeric arrays,
+ * optimizing the resulting payload size.
+ *
+ */
+class JsonIndexed extends Json
+ implements Protobuf\CodecInterface
+{
+
+ protected function encodeMessage(Protobuf\Message $message)
+ {
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ $index = '';
+ $data = array();
+ foreach ($descriptor->getFields() as $tag=>$field) {
+ $empty = !$message->_has($tag);
+ if ($field->isRequired() && $empty) {
+ throw new \UnexpectedValueException(
+ 'Message ' . get_class($message) . '\'s field tag ' . $tag . '(' . $field->getName() . ') is required but has no value'
+ );
+ }
+
+ if ($empty) {
+ continue;
+ }
+
+ $index .= $this->i2c($tag + 48);
+
+ $value = $message->_get($tag);
+
+ if ($field->isRepeated()) {
+ $repeats = array();
+ foreach ($value as $val) {
+ if ($field->getType() !== Protobuf::TYPE_MESSAGE) {
+ $repeats[] = $val;
+ } else {
+ $repeats[] = $this->encodeMessage($val);
+ }
+ }
+ $data[] = $repeats;
+ } else {
+ if ($field->getType() === Protobuf::TYPE_MESSAGE) {
+ $data[] = $this->encodeMessage($value);
+ } else {
+ $data[] = $value;
+ }
+ }
+ }
+
+ // Insert the index at first element
+ array_unshift($data, $index);
+
+ return $data;
+ }
+
+ protected function decodeMessage(Protobuf\Message $message, $data)
+ {
+ // Get message descriptor
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ // Split the index in UTF8 characters
+ preg_match_all('/./u', $data[0], $chars);
+
+ $chars = $chars[0];
+ for ($i=1; $i<count($data); $i++) {
+
+ $k = $this->c2i($chars[$i-1]) - 48;
+ $v = $data[$i];
+
+ $field = $descriptor->getField($k);
+
+ if (NULL === $field) {
+ // Unknown
+ $unknown = new PhpArray\Unknown($k, gettype($v), $v);
+ $message->addUnknown($unknown);
+ continue;
+ }
+
+ if ($field->getType() === Protobuf::TYPE_MESSAGE) {
+ $nested = $field->getReference();
+ if ($field->isRepeated()) {
+ foreach ($v as $vv) {
+ $obj = $this->decodeMessage(new $nested, $vv);
+ $message->_add($k, $obj);
+ }
+ } else {
+ $obj = $this->decodeMessage(new $nested, $v);
+ $message->_set($k, $obj);
+ }
+ } else {
+ $message->_set($k, $v);
+ }
+ }
+
+ return $message;
+ }
+
+ /**
+ * Converts an Unicode codepoint number to an UTF-8 character
+ *
+ * @param int $codepoint
+ * @return string
+ */
+ protected function i2c($codepoint)
+ {
+ return $codepoint < 128
+ ? chr($codepoint)
+ : html_entity_decode("&#$codepoint;", ENT_NOQUOTES, 'UTF-8');
+ }
+
+ /**
+ * Converts an UTF-8 character to an Unicode codepoint number
+ *
+ * @param string $char
+ * @return int
+ */
+ protected function c2i($char)
+ {
+ $value = ord($char[0]);
+ if ($value < 128) return $value;
+
+ if ($value < 224) {
+ return (($value % 32) * 64) + (ord($char[1]) % 64);
+ } else {
+ return (($value % 16) * 4096) +
+ ((ord($char[1]) % 64) * 64) +
+ (ord($char[2]) % 64);
+ }
+ }
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/JsonTagMap.php
@@ -1,1 +1,24 @@
+<?php
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+/**
+ * This codec serializes and unserializes from/to Json strings
+ * where the keys represent the field's tag numbers.
+ *
+ * It makes use of the PhpArray codec to do the heavy work to just
+ * take care of converting the array to/from Json strings.
+ */
+class JsonTagMap extends Json
+ implements Protobuf\CodecInterface
+{
+
+ public function __construct()
+ {
+ // Setup the codec to use tag numbers as keys
+ $this->useTagNumberAsKey(true);
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/PhpArray.php
@@ -1,1 +1,147 @@
+<?php
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+/**
+ * This codec serializes and unserializes data from/to PHP associative
+ * arrays, allowing it to be used as a base for an arbitrary number
+ * of different serializations (json, yaml, ini, xml ...).
+ *
+ */
+class PhpArray implements Protobuf\CodecInterface
+{
+ /** @var bool */
+ protected $useTagNumber = false;
+
+ /**
+ * Tells the codec to expect the array keys to contain the
+ * field's tag number instead of the name.
+ *
+ * @param bool $useIt
+ */
+ public function useTagNumberAsKey($useIt = true)
+ {
+ $this->useTagNumber = $useIt;
+ }
+
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @return array
+ */
+ public function encode(Protobuf\Message $message)
+ {
+ return $this->encodeMessage($message);
+ }
+
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @param array $data
+ * @return \DrSlump\Protobuf\Message
+ */
+ public function decode(Protobuf\Message $message, $data)
+ {
+ return $this->decodeMessage($message, $data);
+ }
+
+ protected function encodeMessage(Protobuf\Message $message)
+ {
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ $data = array();
+ foreach ($descriptor->getFields() as $tag=>$field) {
+
+ $empty = !$message->_has($tag);
+ if ($field->isRequired() && $empty) {
+ throw new \UnexpectedValueException(
+ 'Message ' . get_class($message) . '\'s field tag ' . $tag . '(' . $field->getName() . ') is required but has no value'
+ );
+ }
+
+ if ($empty) {
+ continue;
+ }
+
+ $key = $this->useTagNumber ? $field->getNumber() : $field->getName();
+ $v = $message->_get($tag);
+
+ if ($field->isRepeated()) {
+ // Make sure the value is an array of values
+ $v = is_array($v) ? $v : array($v);
+ foreach ($v as $k=>$vv) {
+ $v[$k] = $this->filterValue($vv, $field);
+ }
+ } else {
+ $v = $this->filterValue($v, $field);
+ }
+
+ $data[$key] = $v;
+ }
+
+ return $data;
+ }
+
+ protected function decodeMessage(Protobuf\Message $message, $data)
+ {
+ // Get message descriptor
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ foreach ($data as $key=>$v) {
+
+ // Get the field by tag number or name
+ $field = $this->useTagNumber
+ ? $descriptor->getField($key)
+ : $descriptor->getFieldByName($key);
+
+ // Unknown field found
+ if (!$field) {
+ $unknown = new PhpArray\Unknown($key, gettype($v), $v);
+ $message->addUnknown($unknown);
+ continue;
+ }
+
+ if ($field->isRepeated()) {
+ // Make sure the value is an array of values
+ $v = is_array($v) && is_int(key($v)) ? $v : array($v);
+ foreach ($v as $k=>$vv) {
+ $v[$k] = $this->filterValue($vv, $field);
+ }
+ } else {
+ $v = $this->filterValue($v, $field);
+ }
+
+ $message->_set($field->getNumber(), $v);
+ }
+
+ return $message;
+ }
+
+ protected function filterValue($value, Protobuf\Field $field)
+ {
+ switch ($field->getType()) {
+ case Protobuf::TYPE_MESSAGE:
+ // Tell apart encoding and decoding
+ if ($value instanceof Protobuf\Message) {
+ return $this->encodeMessage($value);
+ } else {
+ $nested = $field->getReference();
+ return $this->decodeMessage(new $nested, $value);
+ }
+ case Protobuf::TYPE_BOOL:
+ return filter_var($value, FILTER_VALIDATE_BOOLEAN);
+ case Protobuf::TYPE_STRING:
+ case Protobuf::TYPE_BYTES:
+ return (string)$value;
+ case Protobuf::TYPE_FLOAT:
+ case Protobuf::TYPE_DOUBLE:
+ return filter_var($value, FILTER_VALIDATE_FLOAT);
+ // Assume the rest are ints
+ default:
+ return filter_var($value, FILTER_VALIDATE_INT);
+ }
+ }
+
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/PhpArray/Unknown.php
@@ -1,1 +1,14 @@
+<?php
+namespace DrSlump\Protobuf\Codec\PhpArray;
+
+class Unknown extends \DrSlump\Protobuf\Unknown
+{
+ public function __construct($tag, $type, $data)
+ {
+ $this->tag = $tag;
+ $this->type = $type;
+ $this->data = $data;
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/TextFormat.php
@@ -1,1 +1,82 @@
+<?php
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+/**
+ * This codec serializes to Protobuf's TextFormat, unserialization
+ * is not supported.
+ *
+ */
+class TextFormat implements Protobuf\CodecInterface
+{
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @return string
+ */
+ public function encode(Protobuf\Message $message)
+ {
+ return $this->encodeMessage($message);
+ }
+
+ /**
+ *
+ * @throw \DrSlump\Protobuf\Exception - Decoding is not supported
+ * @param \DrSlump\Protobuf\Message $message
+ * @param String $data
+ * @return \DrSlump\Protobuf\Message
+ */
+ public function decode(Protobuf\Message $message, $data)
+ {
+ throw new \BadMethodCallException('TextFormat codec does not support decoding');
+ }
+
+ protected function encodeMessage(Protobuf\Message $message, $level = 0)
+ {
+ $descriptor = Protobuf::getRegistry()->getDescriptor($message);
+
+ $indent = str_repeat(' ', $level);
+ $data = '';
+ foreach ($descriptor->getFields() as $tag=>$field) {
+
+ $empty = !$message->_has($tag);
+ if ($field->isRequired() && $empty) {
+ throw new \UnexpectedValueException(
+ 'Message ' . get_class($message) . '\'s field tag ' . $tag . '(' . $field->getName() . ') is required but has no value'
+ );
+ }
+
+ if ($empty) {
+ continue;
+ }
+
+ $name = $field->getName();
+ $value = $message->_get($tag);
+
+ if ($field->isRepeated()) {
+ foreach ($value as $val) {
+ if ($field->getType() !== Protobuf::TYPE_MESSAGE) {
+ $data .= $indent . $name . ': ' . json_encode($val) . "\n";
+ } else {
+ $data .= $indent . $name . " {\n";
+ $data .= $this->encodeMessage($val, $level+1);
+ $data .= $indent . "}\n";
+ }
+ }
+ } else {
+ if ($field->getType() === Protobuf::TYPE_MESSAGE) {
+ $data .= $indent . $name . " {\n";
+ $data .= $this->encodeMessage($value, $level+1);
+ $data .= $indent . "}\n";
+ } else {
+ $data .= $indent . $name . ': ' . json_encode($value) . "\n";
+ }
+ }
+ }
+
+ return $data;
+ }
+}
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Codec/Xml.php
@@ -1,1 +1,139 @@
+<?php
+namespace DrSlump\Protobuf\Codec;
+
+use DrSlump\Protobuf;
+
+/**
+ * This codec serializes and unserializes from/to Xml documents
+ * where the elements represent the field's name.
+ *
+ * It makes use of the PhpArray codec to do the heavy work to just
+ * take care of converting the array to/from XML.
+ */
+class Xml extends PhpArray
+ implements Protobuf\CodecInterface
+{
+ /** @var bool */
+ protected $dom = false;
+ /** @var string */
+ protected $root;
+
+ /**
+ * @param array $options
+ */
+ public function __construct(array $options = array())
+ {
+ foreach ($options as $option=>$value) {
+ $this->setOption($option, $value);
+ }
+ }
+
+ /**
+ * @throws \InvalidArgumentException
+ * @param string $option
+ * @param mixed $value
+ * @return void
+ */
+ public function setOption($option, $value)
+ {
+ switch (strtolower($option)) {
+ case 'root':
+ $this->root = $value;
+ break;
+ case 'dom':
+ $this->dom = (bool)$value;
+ break;
+ default:
+ throw new \InvalidArgumentException('Unknown option ' . $option);
+ }
+ }
+
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @return string | \SimpleXMLElement
+ */
+ public function encode(Protobuf\Message $message)
+ {
+ // Generate an associative array
+ $data = $this->encodeMessage($message);
+
+ // Build an XML representation
+ $root = $this->root ?: str_replace('\\', '_', get_class($message));
+ $root = new \SimpleXMLElement('<?xml version="1.0"?><' . $root . '></' . $root . '>');
+ $this->arrayToXml($root, $data);
+
+ return $this->dom ? $root : $root->asXML();
+ }
+
+ /**
+ * @param \SimpleXMLElement $elem
+ * @param array $data
+ * @param null $label
+ */
+ protected function arrayToXml(\SimpleXMLElement $elem, array $data, $label = null)
+ {
+ foreach ($data as $k=>$v) {
+ if (is_array($v)) {
+ // Detect nested messages
+ if (!is_int(key($v))) {
+ $child = $elem->addChild($label ?: $k);
+ $this->arrayToXml($child, $v);
+ // Lists are forced a fixed label
+ } else {
+ $this->arrayToXml($elem, $v, $k);
+ }
+ } else {
+ $elem->addChild($label ?: $k, $v);
+ }
+ }
+ }
+
+ /**
+ * @param \DrSlump\Protobuf\Message $message
+ * @param string | \SimpleXMLElement $xml
+ * @return \DrSlump\Protobuf\Message
+ */
+ public function decode(Protobuf\Message $message, $xml)
+ {
+ if (is_string($xml)) {
+ $xml = new \SimpleXMLElement($xml);
+ }
+
+ // Build an associative array from the XML
+ $data = $this->xmlToArray($xml);
+ // Generate a message from the data
+ return $this->decodeMessage($message, $data);
+ }
+
+ /**
+ * @param \SimpleXMLElement $elem
+ * @return array
+ */
+ protected function xmlToArray(\SimpleXMLElement $elem)
+ {
+ $data = array();
+ foreach ($elem->children() as $child) {
+ if (count($child->children())) {
+ $value = $this->xmlToArray($child);
+ } else {
+ $value = (string)$child;
+ }
+
+ $name = $child->getName();
+ if (isset($data[$name])) {
+ // If not yet a "list" array
+ if (!is_array($data[$name]) || !is_int(key($data[$name]))) {
+ $data[$name] = array($data[$name]);
+ }
+ $data[$name][] = $value;
+ } else {
+ $data[$name] = $value;
+ }
+ }
+
+ return $data;
+ }
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/CodecInterface.php
@@ -1,1 +1,9 @@
+<?php
+namespace DrSlump\Protobuf;
+
+interface CodecInterface
+{
+ public function encode(\DrSlump\Protobuf\Message $message);
+ public function decode(\DrSlump\Protobuf\Message $message, $data);
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler.php
@@ -1,1 +1,212 @@
-
+<?php
+
+namespace DrSlump\Protobuf;
+
+// Load descriptor messages
+require_once __DIR__ . '/Compiler/protos/descriptor.pb.php';
+require_once __DIR__ . '/Compiler/protos/plugin.pb.php';
+require_once __DIR__ . '/Compiler/protos/php.pb.php';
+require_once __DIR__ . '/Compiler/protos/json.pb.php';
+
+use DrSlump\Protobuf;
+use google\protobuf as proto;
+
+class Compiler
+{
+ /** @var bool */
+ protected $verbose = false;
+ /** @var array */
+ protected $packages = array();
+ /** @var \DrSlump\Protobuf\Compiler\CommentsParser */
+ protected $comments;
+ /** @var bool */
+ protected $skipImported = false;
+ /** @var array */
+ protected $options = array();
+ /** @var array */
+ protected $protos = array();
+
+ public function __construct($verbose = false)
+ {
+ $this->verbose = $verbose;
+ $this->comments = new Compiler\CommentsParser();
+ }
+
+ public function stderr($str)
+ {
+ $str = str_replace("\n", PHP_EOL, $str);
+ fputs(STDERR, $str . PHP_EOL);
+ }
+
+ public function notice($str)
+ {
+ if ($this->verbose) {
+ $this->stderr('NOTICE: ' . $str);
+ }
+ }
+
+ public function warning($str)
+ {
+ $this->stderr('WARNING: ' . $str);
+ }
+
+ protected function error($str)
+ {
+ $this->stderr('ERROR: ' . $str);
+ }
+
+ public function getPackages()
+ {
+ return $this->packages;
+ }
+
+ public function hasPackage($package)
+ {
+ return isset($this->packages[$package]);
+ }
+
+ public function getPackage($package)
+ {
+ return $this->packages[$package];
+ }
+
+ public function setPackage($package, $namespace)
+ {
+ $this->packages[$package] = $namespace;
+ }
+
+ public function getOption($option, $type = 'string')
+ {
+ $value = isset($this->options[$option])
+ ? $this->options[$option]
+ : null;
+
+ switch ($type) {
+ case 'bool':
+ return filter_var($value, FILTER_VALIDATE_BOOLEAN);
+ default:
+ return $value;
+ }
+ }
+
+ public function camelize($name)
+ {
+ return preg_replace_callback(
+ '/_([a-z])/i',
+ function($m){ return strtoupper($m[1]); },
+ $name
+ );
+ }
+
+ public function compile($data)
+ {
+ // Parse the request
+ $req = new \google\protobuf\compiler\CodeGeneratorRequest($data);
+
+ // Set default generator class
+ $generator = __CLASS__ . '\PhpGenerator';
+
+ // Reset comments parser
+ $this->comments->reset();
+ $parseComments = false;
+
+ // Get plugin arguments
+ if ($req->hasParameter()) {
+ parse_str($req->getParameter(), $args);
+ foreach ($args as $arg=>$val) {
+ switch($arg){
+ case 'verbose':
+ $this->verbose = filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
+ break;
+ case 'json':
+ $this->notice("Using ProtoJson generator");
+ $generator = __CLASS__ . '\JsonGenerator';
+ break;
+ case 'comments':
+ $parseComments = filter_var($val, FILTER_VALIDATE_BOOLEAN);
+ break;
+ case 'protos':
+ $this->protos = $val;
+ break;
+ case 'skip-imported':
+ $this->skipImported = filter_var($val, FILTER_VALIDATE_BOOLEAN);
+ break;
+ case 'options':
+ $this->options = $val;
+ break;
+ default:
+ $this->warning('Skipping unknown option ' . $arg);
+ }
+ }
+ }
+
+ // Parse comments if we're told to do so
+ if ($parseComments) {
+ if (empty($this->protos)) {
+ throw new \RuntimeException('Unable to port comments if .proto files are not passed as argument');
+ }
+ foreach ($this->protos as $fname) {
+ $src = file_get_contents($fname);
+ if (FALSE === $src) {
+ throw new \RuntimeException('Unable to parse file ' . $fname . ' for comments');
+ }
+ $this->comments->parse($src);
+ }
+ }
+
+ /** @var $generator \DrSlump\Protobuf\Compiler\AbstractGenerator */
+ $generator = new $generator($this);
+
+ // Setup response object
+ $resp = new \google\protobuf\compiler\CodeGeneratorResponse();
+
+ // First iterate over all the protos to get a map of namespaces
+ $this->packages = array();
+ foreach($req->getProtoFileList() as $proto) {
+ $package = $proto->getPackage();
+ $namespace = $generator->getNamespace($proto);
+ if (isset($this->packages[$package]) && $namespace !== $this->packages[$package]) {
+ $this->warning("Package $package was already mapped to {$this->packages[$package]} but has now been overridden to $namespace");
+ }
+ $this->packages[$package] = $namespace;
+ $this->notice("Mapping $package to $namespace");
+ }
+
+ // Get the list of files to generate
+ $files = $req->getFileToGenerate();
+
+ // Run each file
+ foreach ($req->getProtoFileList() as $file) {
+ // Only compile those given to generate, not the imported ones
+ if ($this->skipImported && !in_array($file->getName(), $files)) {
+ $this->notice('Skipping generation of imported file "' . $file->getName() . '"');
+ continue;
+ }
+
+ $sources = $generator->generate($file);
+ foreach ($sources as $source) {
+ $this->notice('Generating "' . $source->getName() . '"');
+ $resp->addFile($source);
+ }
+ }
+
+ // Finally serialize the response object
+ return $resp->serialize();
+ }
+
+ public function getComment($ident, $prefix = '')
+ {
+ if (!$this->comments->hasComment($ident)) {
+ return null;
+ }
+
+ $comment = $this->comments->getComment($ident);
+ if (0 < strlen($prefix)) {
+ $comment = $prefix . str_replace("\n", "\n$prefix", $comment);
+ }
+
+ return $comment;
+ }
+}
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/AbstractGenerator.php
@@ -1,1 +1,41 @@
+<?php
+namespace DrSlump\Protobuf\Compiler;
+
+use google\protobuf as proto;
+
+abstract class AbstractGenerator
+{
+ /** @var \DrSlump\Protobuf\Compiler */
+ protected $compiler;
+ /** @var \google\protobuf\FileDescriptorProto */
+ protected $proto;
+
+ /** @var array */
+ protected $extensions = array();
+
+ public function __construct(\DrSlump\Protobuf\Compiler $compiler)
+ {
+ $this->compiler = $compiler;
+ }
+
+ public function getNamespace(proto\FileDescriptorProto $proto = NULL)
+ {
+ return NULL === $proto
+ ? $this->proto->getPackage()
+ : $proto->getPackage();
+ }
+
+ public function generate(proto\FileDescriptorProto $proto)
+ {
+ $this->proto = $proto;
+ }
+
+
+ abstract protected function compileEnum(proto\EnumDescriptorProto $enum, $namespace);
+
+ abstract protected function compileMessage(proto\DescriptorProto $msg, $namespace);
+
+ abstract protected function compileExtension(proto\FieldDescriptorProto $field, $ns, $indent);
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/Cli.php
@@ -1,1 +1,238 @@
-
+<?php
+
+namespace DrSlump\Protobuf\Compiler;
+
+require_once 'Console/CommandLine.php';
+
+use DrSlump\Protobuf;
+
+class Cli
+{
+ public static function run($pluginExecutable)
+ {
+ // Open STDIN in non-blocking mode
+ $fp = fopen('php://stdin', 'rb');
+ stream_set_blocking($fp, FALSE);
+
+ // Loop until STDIN is closed or we've waited too long for data
+ $cnt = 0;
+ $stdin = '';
+ while (!feof($fp) && $cnt++ < 10) {
+ // give protoc some time to feed the data
+ usleep(10000);
+ // read the bytes
+ $bytes = fread($fp, 1024);
+ if (strlen($bytes)) {
+ $cnt = 0;
+ $stdin .= $bytes;
+ }
+ }
+
+ // If no input was given we launch protoc from here
+ if (0 === strlen($stdin)) {
+ self::runProtoc($pluginExecutable);
+ exit(0);
+ }
+
+ // We have data from stdin so compile it
+ try {
+ // Create a compiler interface
+ $comp = new Protobuf\Compiler();
+ echo $comp->compile($stdin);
+ exit(0);
+ } catch(\Exception $e) {
+ fputs(STDERR, 'ERROR: ' . $e->getMessage());
+ fputs(STDERR, $e->getTraceAsString());
+ exit(255);
+ }
+ }
+
+ public static function runProtoc($pluginExecutable)
+ {
+ $result = self::parseArguments();
+
+ $protocBin = $result->options['protoc'];
+
+ // Check if protoc is available
+ exec("$protocBin --version", $output, $return);
+
+ if (0 !== $return && 1 !== $return) {
+ fputs(STDERR, "ERROR: Unable to find the protoc command.". PHP_EOL);
+ fputs(STDERR, " Please make sure it's installed and available in the path." . PHP_EOL);
+ exit(1);
+ }
+
+ if (!preg_match('/[0-9\.]+/', $output[0], $m)) {
+ fputs(STDERR, "ERROR: Unable to get protoc command version.". PHP_EOL);
+ fputs(STDERR, " Please make sure it's installed and available in the path." . PHP_EOL);
+ exit(1);
+ }
+
+ if (version_compare($m[0], '2.3.0') < 0) {
+ fputs(STDERR, "ERROR: The protoc command in your system is too old." . PHP_EOL);
+ fputs(STDERR, " Minimum version required is 2.3.0 but found {$m[0]}." . PHP_EOL);
+ exit(1);
+ }
+
+ $cmd[] = $protocBin;
+ $cmd[] = '--plugin=protoc-gen-php=' . escapeshellarg($pluginExecutable);
+
+ // Include paths
+ $cmd[] = '--proto_path=' . escapeshellarg(__DIR__ . DIRECTORY_SEPARATOR . 'protos');
+ if (!empty($result->options['include'])) {
+ foreach($result->options['include'] as $include) {
+ $include = realpath($include);
+ $cmd[] = '--proto_path=' . escapeshellarg($include);
+ }
+ }
+
+ // Convert proto files to absolute paths
+ $protos = array();
+ foreach ($result->args['protos'] as $proto) {
+ $realpath = realpath($proto);
+ if (FALSE === $realpath) {
+ fputs(STDERR, "ERROR: File '$proto' does not exists");
+ exit(1);
+ }
+
+ $protos[] = $realpath;
+ }
+
+ // Protoc will pass custom arguments to the plugin if they are given
+ // before a colon character. ie: --php_out="foo=bar:/path/to/plugin"
+ // We make use of it to pass arguments encoded as an URI query string
+
+ $args = array();
+ if ($result->options['comments']) {
+ $args['comments'] = 1;
+ // Protos are only needed for comments right now
+ $args['protos'] = $protos;
+ }
+ if ($result->options['verbose']) {
+ $args['verbose'] = 1;
+ }
+ if ($result->options['json']) {
+ $args['json'] = 1;
+ }
+ if ($result->options['skipImported']) {
+ $args['skip-imported'] = 1;
+ }
+ if ($result->options['define']) {
+ $args['options'] = array();
+ foreach($result->options['define'] as $define) {
+ $parts = explode('=', $define);
+ $parts = array_filter(array_map('trim', $parts));
+ if (count($parts) === 1) {
+ $parts[1] = 1;
+ }
+ $args['options'][$parts[0]] = $parts[1];
+ }
+ }
+
+ $cmd[] = '--php_out=' .
+ escapeshellarg(
+ http_build_query($args, '', '&') .
+ ':' .
+ $result->options['out']
+ );
+
+ // Add the chosen proto files to generate
+ foreach ($protos as $proto) {
+ $cmd[] = escapeshellarg($proto);
+ }
+
+ $cmdStr = implode(' ', $cmd);
+
+ // Run command with stderr redirected to stdout
+ passthru($cmdStr . ' 2>&1', $return);
+
+ if ($return !== 0) {
+ fputs(STDERR, PHP_EOL);
+ fputs(STDERR, 'ERROR: protoc exited with an error (' . $return . ') when executed with: ' . PHP_EOL);
+ fputs(STDERR, ' ' . implode(" \\\n ", $cmd) . PHP_EOL);
+ exit($return);
+ }
+ }
+
+
+ public static function parseArguments()
+ {
+ $main = new \Console_CommandLine();
+
+ $main->addOption('out', array(
+ 'short_name' => '-o',
+ 'long_name' => '--out',
+ 'action' => 'StoreString',
+ 'description' => 'destination directory for generated files',
+ 'default' => './',
+ ));
+
+ $main->addOption('include', array(
+ 'short_name' => '-i',
+ 'long_name' => '--include',
+ 'action' => 'StoreArray',
+ 'description' => 'define an include path (can be repeated)',
+ 'multiple' => true,
+ ));
+
+
+ $main->addOption('json', array(
+ 'short_name' => '-j',
+ 'long_name' => '--json',
+ 'action' => 'StoreTrue',
+ 'description' => 'turn on ProtoJson Javascript file generation',
+ ));
+
+ $main->addOption('protoc', array(
+ 'long_name' => '--protoc',
+ 'action' => 'StoreString',
+ 'default' => 'protoc',
+ 'description' => 'protoc compiler executable path',
+ ));
+
+ $main->addOption('skipImported', array(
+ 'long_name' => '--skip-imported',
+ 'action' => 'StoreTrue',
+ 'default' => false,
+ 'description' => 'do not generate imported proto files',
+ ));
+
+ $main->addOption('comments', array(
+ 'long_name' => '--comments',
+ 'action' => 'StoreTrue',
+ 'description' => 'port .proto comments to generated code',
+ ));
+
+ $main->addOption('define', array(
+ 'short_name' => '-D',
+ 'long_name' => '--define',
+ 'action' => 'StoreArray',
+ 'multiple' => true,
+ 'description' => 'define a generator option (ie: -Dmultifile -Dsuffix=pb.php)',
+ ));
+
+ $main->addOption('verbose', array(
+ 'short_name' => '-v',
+ 'long_name' => '--verbose',
+ 'action' => 'StoreTrue',
+ 'description' => 'turn on verbose output',
+ ));
+
+
+ $main->addArgument('protos', array(
+ 'multiple' => true,
+ 'description' => 'proto files',
+ ));
+
+ try {
+ echo 'Protobuf-PHP ' . Protobuf::VERSION . ' by Ivan -DrSlump- Montes' . PHP_EOL . PHP_EOL;
+ $result = $main->parse();
+ return $result;
+ } catch (\Exception $e) {
+ $main->displayError($e->getMessage());
+ exit(1);
+ }
+ }
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/CommentsParser.php
@@ -1,1 +1,136 @@
+<?php
+namespace DrSlump\Protobuf\Compiler;
+
+class CommentsParser
+{
+ /** @var array - Hold a mapping of entity => comment */
+ protected $comments = array();
+
+ /** @var array - Define tokenizer regular expressions */
+ protected $tokens = array(
+ 'comment' => '/\*([\S\s]+?)\*/',
+ 'package' => 'package\s+([A-Z0-9_]+)',
+ 'struct' => '(?:message|enum|service)\s+([A-Z0-9_]+)',
+ 'close' => '}',
+ 'field' => '(?:required|optional|repeated)\s+[^=]+=\s*([0-9]+)[^;]*;',
+ 'rpc' => 'rpc\s+([A-Z0-9_]+)[^;]+'
+ );
+
+ /** @var string - The regular expresion for the tokenizer */
+ protected $regexp;
+
+ public function __construct()
+ {
+ // Generate a regular expression for all tokens
+ $regexp = array();
+ foreach ($this->tokens as $token=>$exp) {
+ $regexp[] = '(?<' . $token . '>' . $exp . ')';
+ }
+ $this->regexp = '@' . implode('|', $regexp) . '@i';
+ }
+
+ /**
+ * Reset the currently stored comments
+ */
+ public function reset()
+ {
+ $this->comments = array();
+ }
+
+ /**
+ * Parse a Proto file source code to fetch comments
+ *
+ * @param string $src
+ */
+ public function parse($src)
+ {
+ // Build an stream of tokens from the regular expression
+ $tokens = array();
+ $offset = 0;
+ while (preg_match($this->regexp, $src, $m, PREG_OFFSET_CAPTURE, $offset)) {
+ foreach ($this->tokens as $k=>$v) {
+ if (!empty($m[$k]) && 0 < strlen($m[$k][0])) {
+ $tokens[] = array(
+ 'token' => $k,
+ 'value' => array_shift(array_pop($m)),
+ );
+ }
+ }
+ $offset = $m[0][1] + strlen($m[0][0]);
+ }
+
+ // Parse the tokens stream to assign comments
+ $comment = null;
+ $stack = array();
+ foreach ($tokens as $token) {
+ if ($token['token'] === 'comment') {
+ $comment = $token['value'];
+ } elseif ($token['token'] === 'package') {
+ $stack[] = $token['value'];
+ $comment = null;
+ } elseif ($token['token'] === 'struct') {
+ $stack[] = $token['value'];
+ if ($comment) {
+ $this->setComment(implode('.', $stack), $comment);
+ $comment = null;
+ }
+ } elseif ($token['token'] === 'close') {
+ array_pop($stack);
+ $comment = null;
+ } elseif ($token['token'] === 'field' || $token['token'] === 'rpc') {
+ if ($comment) {
+ $this->setComment(implode('.', $stack) . '.' . $token['value'], $comment);
+ $comment = null;
+ }
+ }
+ }
+ }
+
+ /**
+ * Set a comment for the given identifier. The identifier is composed
+ * of the package, followed by the message (and nested messages). Field
+ * comments are suffixed with the tag number.
+ *
+ * @example
+ *
+ * $this->setComment('MyPackage.MyMessage.Nested.2', 'field comment');
+ *
+ * @param string $ident
+ * @param string $comment
+ */
+ public function setComment($ident, $comment)
+ {
+ $comment = str_replace("\r\n", "\n", $comment);
+ $comment = preg_replace('/^[\s\*]+/m', '', $comment);
+ $comment = trim($comment, "* \n");
+ $this->comments[$ident] = $comment;
+ }
+
+ /**
+ * Get the comment for a given identifier
+ *
+ * @param string $ident
+ * @return string|null
+ */
+ public function getComment($ident)
+ {
+ return isset($this->comments[$ident])
+ ? $this->comments[$ident]
+ : null;
+ }
+
+ /**
+ * Checks if a comment exists for a given identifier
+ *
+ * @param string $ident
+ * @return bool
+ */
+ public function hasComment($ident)
+ {
+ return isset($this->comments[$ident]);
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/JsonGenerator.php
@@ -1,1 +1,353 @@
-
+<?php
+
+namespace DrSlump\Protobuf\Compiler;
+
+use DrSlump\Protobuf;
+use google\protobuf as proto;
+
+class JsonGenerator extends AbstractGenerator
+{
+ public function getNamespace(proto\FileDescriptorProto $proto)
+ {
+ $namespace = $proto->getPackage();
+ $opts = $proto->getOptions();
+ if (isset($opts['json.package'])) {
+ $namespace = $opts['jsonpackage'];
+ }
+ if (isset($opts['json.namespace'])) {
+ $namespace = $opts['json.namespace'];
+ }
+
+ $namespace = trim($namespace, '.');
+ return $namespace;
+ }
+
+ public function compileEnum(proto\EnumDescriptorProto $enum, $namespace)
+ {
+ $s[]= "$namespace.$enum->name = {";
+ $lines = array();
+ foreach ($enum->getValueList() as $value) {
+ $lines[] = " /** @const */ $value->name: $value->number";
+ }
+ $s[]= implode(",\n", $lines);
+ $s[]= '};';
+ $s[]= '';
+ return implode("\n", $s);
+ }
+
+ public function compileExtension(proto\FieldDescriptorProto $field, $ns, $indent)
+ {
+ $extendee = $this->normalizeReference($field->getExtendee());
+ $name = $field->getName();
+ if ($ns) {
+ $name = $ns . '.' . $name;
+ }
+ $field->setName($name);
+
+ $s[]= "ProtoJson.extend($extendee, {";
+ $s[]= " $field->number: " . $this->generateField($field);
+ $s[]= "});";
+ $s[]= '';
+
+ return $indent . implode("\n$indent", $s);
+ }
+
+ public function compileMessage(proto\DescriptorProto $msg, $namespace)
+ {
+ $s[]= "/**";
+ $s[]= " * @constructor";
+ $s[]= " * @augments {ProtoJson.Message}";
+ $s[]= " * @extends ProtoJson.Message";
+ $s[]= " * @memberOf $namespace";
+ $s[]= " * @param {object} data - Optional, provide initial data to parse";
+ $s[]= " */";
+ $s[]= "$namespace.$msg->name = ProtoJson.create({";
+ $s[]= " fields: {";
+
+ $lines = array();
+ foreach ($msg->getFieldList() as $field) {
+ $lines[] = " $field->number: " . $this->generateField($field);
+ }
+ $s[] = implode(",\n", $lines);
+
+ $s[]= " },";
+ $s[]= " ranges: [";
+ // @todo dump extension ranges
+ $s[]= " ]";
+ $s[]= "});";
+ $s[]= "";
+
+ // Compute a new namespace with the message name as suffix
+ $namespace .= "." . $msg->getName();
+
+ // Generate getters/setters
+ foreach ($msg->getFieldList() as $field) {
+ $s[]= $this->generateAccessors($field, $namespace);
+ }
+
+ // Generate Enums
+ foreach ($msg->getEnumTypeList() as $enum):
+ $s[]= $this->compileEnum($enum, $namespace);
+ endforeach;
+
+ // Generate nested messages
+ foreach ($msg->getNestedTypeList() as $msg):
+ $s[]= $this->compileMessage($msg, $namespace);
+ endforeach;
+
+ // Collect extensions
+ foreach ($msg->getExtensionList() as $field) {
+ $this->extensions[$field->getExtendee()][] = array($namespace, $field);
+ }
+
+ return implode("\n", $s);
+ }
+
+ public function compileProtoFile(proto\FileDescriptorProto $proto)
+ {
+ $file = new proto\compiler\CodeGeneratorResponse\File();
+
+ $opts = $proto->getOptions();
+ $name = pathinfo($proto->getName(), PATHINFO_FILENAME);
+ $name .= isset($opts['json.suffix'])
+ ? $opts['json.suffix']
+ : '.js';
+ $file->setName($name);
+
+ $namespace = $this->getNamespace($proto);
+
+ $s[]= "// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin " . Protobuf::VERSION;
+ $s[]= "// Source: " . $proto->getName();
+ $s[]= "// Date: " . date('Y-m-d H:i:s');
+ $s[]= "";
+
+ $s[]= "(function(){";
+ $s[]= "/** @namespace */";
+ $s[]= "var $namespace = $namespace || {};";
+ $s[]= "";
+ $s[]= "// Make it CommonJS compatible";
+ $s[]= "if (typeof exports !== 'undefined') {";
+ $s[]= " var ProtoJson = this.ProtoJson;";
+ $s[]= " if (!ProtoJson && typeof require !== 'undefined')";
+ $s[]= " ProtoJson = require('ProtoJson');";
+ $s[]= " $namespace = exports;";
+ $s[]= "} else {";
+ $s[]= " this.$namespace = $namespace;";
+ $s[]= "}";
+ $s[]= "";
+
+
+ // Generate Enums
+ foreach ($proto->getEnumTypeList() as $enum) {
+ $s[]= $this->compileEnum($enum, $namespace);
+ }
+
+ // Generate Messages
+ foreach ($proto->getMessageTypeList() as $msg) {
+ $s[] = $this->compileMessage($msg, $namespace);
+ }
+
+ // Collect extensions
+ if ($proto->hasExtension()) {
+ foreach ($proto->getExtensionList() as $field) {
+ $this->extensions[$field->getExtendee()][] = array($namespace, $field);
+ }
+ }
+
+ // Dump all extensions found in this proto file
+ if (count($this->extensions)) {
+ foreach ($this->extensions as $extendee => $fields) {
+ foreach ($fields as $pair) {
+ list($ns, $field) = $pair;
+ $s[]= $this->compileExtension($field, $ns, '');
+ }
+ }
+ }
+
+ $s[]= "})();";
+
+ $src = implode("\n", $s);
+ $file->setContent($src);
+ return array($file);
+ }
+
+ public function generateField(proto\FieldDescriptorProto $field)
+ {
+ $reference = 'null';
+ if ($field->hasTypeName()) {
+ $reference = $field->getTypeName();
+ if (substr($reference, 0, 1) !== '.') {
+ throw new \RuntimeException('Only fully qualified names are supported: ' . $reference);
+ }
+ $reference = "'" . $this->normalizeReference($reference) . "'";
+ }
+
+ $default = 'null';
+ if ($field->hasDefaultValue()):
+ switch ($field->getType()) {
+ case Protobuf::TYPE_BOOL:
+ $default = $field->getDefaultValue() ? 'true' : 'false';
+ break;
+ case Protobuf::TYPE_STRING:
+ $default = '"' . addcslashes($field->getDefaultValue(), '"\\') . '"';
+ break;
+ case Protobuf::TYPE_ENUM:
+ $default = $this->normalizeReference($field->getTypeName()) . '.' . $field->getDefaultValue();
+ break;
+ default: // Numbers
+ $default = $field->getDefaultValue();
+ }
+ endif;
+
+ $data = array(
+ "'" . $field->getName() . "'",
+ $field->getLabel(),
+ $field->getType(),
+ $reference,
+ $default,
+ '{}'
+ );
+
+ return '[' . implode(', ', $data) . ']';
+ }
+
+ public function generateAccessors($field, $namespace)
+ {
+ $camel = $this->comp->camelize(ucfirst($field->getName()));
+
+ $s[]= "/**";
+ $s[]= " * Check <$field->name> value";
+ $s[]= " * @return {Boolean}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.has$camel = function(){";
+ $s[]= " return this._has($field->number);";
+ $s[]= "};";
+ $s[]= "";
+
+ $s[]= "/**";
+ $s[]= " * Set a value for <$field->name>";
+ $s[]= " * @param {" . $this->getJsDoc($field) . "} value";
+ $s[]= " * @return {". $namespace . "}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.set$camel = function(value){";
+ $s[]= " return this._set($field->number, value);";
+ $s[]= "};";
+ $s[]= "";
+
+
+ $s[]= "/**";
+ $s[]= " * Clear the value of <$field->name>";
+ $s[]= " * @return {". $namespace . "}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.clear$camel = function(){";
+ $s[]= " return this._clear($field->number);";
+ $s[]= "};";
+ $s[]= "";
+
+
+ if ($field->getLabel() !== Protobuf::RULE_REPEATED):
+
+ $s[]= "/**";
+ $s[]= " * Get <$field->name> value";
+ $s[]= " * @return {" . $this->getJsDoc($field) . "}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.get$camel = function(){";
+ $s[]= " return this._get($field->number);";
+ $s[]= "};";
+ $s[]= "";
+
+ else:
+
+ $s[]= "/**";
+ $s[]= " * Get an item from <$field->name>";
+ $s[]= " * @param {int} idx";
+ $s[]= " * @return {" . $this->getJsDoc($field) . "}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.get$camel = function(idx){";
+ $s[]= " return this._get($field->number, idx);";
+ $s[]= "};";
+ $s[]= "";
+
+
+ $s[]= "/**";
+ $s[]= " * Get <$field->name> value";
+ $s[]= " * @return {" . $this->getJsDoc($field) . "[]}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.get{$camel}List = function(){";
+ $s[]= " return this._get($field->number);";
+ $s[]= "};";
+ $s[]= "";
+
+ $s[]= "/**";
+ $s[]= " * Add a value to <$field->name>";
+ $s[]= " * @param {" . $this->getJsDoc($field) . "} value";
+ $s[]= " * @return {" . $namespace . "}";
+ $s[]= " */";
+ $s[]= "$namespace.prototype.add$camel = function(value){";
+ $s[]= " return this._add($field->number, value);";
+ $s[]= "};";
+ $s[]= "";
+
+ endif;
+
+
+ return implode("\n", $s);
+ }
+
+ public function getJsDoc(proto\FieldDescriptorProto $field)
+ {
+ switch ($field->getType()) {
+ case Protobuf::TYPE_DOUBLE:
+ case Protobuf::TYPE_FLOAT:
+ return 'Float';
+ case Protobuf::TYPE_INT64:
+ case Protobuf::TYPE_UINT64:
+ case Protobuf::TYPE_INT32:
+ case Protobuf::TYPE_FIXED64:
+ case Protobuf::TYPE_FIXED32:
+ case Protobuf::TYPE_UINT32:
+ case Protobuf::TYPE_SFIXED32:
+ case Protobuf::TYPE_SFIXED64:
+ case Protobuf::TYPE_SINT32:
+ case Protobuf::TYPE_SINT64:
+ return 'Int';
+ case Protobuf::TYPE_BOOL:
+ return 'Boolean';
+ case Protobuf::TYPE_STRING:
+ return 'String';
+ case Protobuf::TYPE_MESSAGE:
+ return $this->normalizeReference($field->getTypeName());
+ case Protobuf::TYPE_BYTES:
+ return 'String';
+ case Protobuf::TYPE_ENUM:
+ return 'Int (' . $this->normalizeReference($field->getTypeName()) . ')';
+
+ case Protobuf::TYPE_GROUP:
+ default:
+ return 'unknown';
+ }
+ }
+
+ public function normalizeReference($reference)
+ {
+ // Remove leading dot
+ $reference = ltrim($reference, '.');
+
+ if (!$this->comp->hasPackage($reference)) {
+ $found = false;
+ foreach ($this->comp->getPackages() as $package=>$namespace) {
+ if (0 === strpos($reference, $package.'.')) {
+ $reference = $namespace . substr($reference, strlen($package));
+ $found = true;
+ }
+ }
+ if (!$found) {
+ $this->comp->warning('Non tracked package name found "' . $reference . '"');
+ }
+ } else {
+ $reference = $this->comp->getPackage($reference);
+ }
+
+ return $reference;
+ }
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/PhpGenerator.php
@@ -1,1 +1,610 @@
-
+<?php
+
+namespace DrSlump\Protobuf\Compiler;
+
+use DrSlump\Protobuf;
+use google\protobuf as proto;
+
+class PhpGenerator extends AbstractGenerator
+{
+ protected $components = array();
+
+ protected function addComponent($ns, $name, $src)
+ {
+ if (NULL !== $ns) {
+ $name = $this->normalizeNS($ns . '.' . $name);
+ }
+ $this->components[$name] = $src;
+ }
+
+ /**
+ * Get an option from the compiler arguments or from the proto file.
+ *
+ * @param string $name
+ * @return string|null
+ */
+ protected function getOption($name)
+ {
+ $opt = $this->compiler->getOption($name);
+
+ if (NULL === $opt) {
+ $opts = $this->proto->getOptions();
+ if (!empty($opts) && isset($opts['php.' . $name])) {
+ $opt = $opts['php.' . $name];
+ }
+ }
+
+ return $opt;
+ }
+
+ public function getNamespace(proto\FileDescriptorProto $proto = NULL)
+ {
+ $proto = $proto ?: $this->proto;
+
+ $opts = $proto->getOptions();
+ if ($this->compiler->getOption('namespace')) {
+ $namespace = $this->compiler->getOption('namespace');
+ } else if ($this->compiler->getOption('package')) {
+ $namespace = $this->compiler->getOption('package');
+ } else if (isset($opts['php.namespace'])) {
+ $namespace = $opts['php.namespace'];
+ } else {
+ $namespace = parent::getNamespace($proto);
+ }
+
+ $namespace = trim($namespace, '.\\');
+ return str_replace('.', '\\', $namespace);
+ }
+
+ public function generate(proto\FileDescriptorProto $proto)
+ {
+ parent::generate($proto);
+
+ $this->components = array();
+ $namespace = $proto->getPackage();
+
+ // Generate Enums
+ foreach ($proto->getEnumType() as $enum) {
+ $src = $this->compileEnum($enum, $namespace);
+ $this->addComponent($namespace, $enum->getName(), $src);
+ }
+
+ // Generate Messages
+ foreach ($proto->getMessageType() as $msg) {
+ $src = $this->compileMessage($msg, $namespace);
+ $this->addComponent($namespace, $msg->getName(), $src);
+ }
+
+ // Generate services
+ if ($this->getOption('generic_services') && count($proto->hasService())):
+ foreach ($proto->getServiceList() as $service) {
+ $src = $this->compileService($service, $namespace);
+ $this->addComponent($namespace, $service->getName(), $src);
+ }
+ endif;
+
+ // Collect extensions
+ if ($proto->hasExtension()) {
+ foreach ($proto->getExtensionList() as $field) {
+ $this->extensions[$field->getExtendee()][] = array($namespace, $field);
+ }
+ }
+
+ // Dump all extensions found in this proto file
+ if (count($this->extensions)):
+ $s[]= 'namespace {';
+ foreach ($this->extensions as $extendee => $fields) {
+ foreach ($fields as $pair) {
+ list($ns, $field) = $pair;
+ $s[] = $this->compileExtension($field, $ns, ' ');
+ }
+ }
+ $s[]= '}';
+
+ $src = implode(PHP_EOL, $s);
+
+ // In multifile mode we output all the extensions in a file named after
+ // the proto file, since it's not trivial or even possible in all cases
+ // to include the extensions with the extended message file.
+ $fname = pathinfo($proto->getName(), PATHINFO_FILENAME);
+ $this->addComponent(null, $fname . '-extensions', $src);
+
+ // Reset extensions for next proto file
+ $this->extensions = array();
+ endif;
+
+
+ $files = array();
+ if (!$this->getOption('multifile')) {
+ $src = '';
+ foreach ($this->components as $content) {
+ $src .= $content;
+ }
+ $fname = pathinfo($proto->getName(), PATHINFO_FILENAME);
+ $files[] = $this->buildFile($proto, $fname, $src);
+ } else {
+ foreach ($this->components as $ns => $content) {
+ $fname = str_replace('\\', '/', $ns);
+ $files[] = $this->buildFile($proto, $fname, $content);
+ }
+ }
+
+ return $files;
+ }
+
+ protected function buildFile(proto\FileDescriptorProto $proto, $fname, $contents)
+ {
+ $suffix = $this->getOption('suffix') ?: '.php';
+ $fname .= $suffix;
+
+ $file = new \google\protobuf\compiler\CodeGeneratorResponse\File();
+ $file->setName($fname);
+
+ $s = array();
+ $s[]= "<?php";
+ $s[]= "// DO NOT EDIT! Generated by Protobuf-PHP protoc plugin " . Protobuf::VERSION;
+ $s[]= "// Source: " . $proto->getName();
+ $s[]= "// Date: " . date('Y-m-d H:i:s');
+ $s[]= "";
+ $s[]= "// @@protoc_insertion_point(scope_file)";
+ $s[]= "";
+
+ $contents = implode(PHP_EOL, $s) . PHP_EOL . $contents;
+ $file->setContent($contents);
+ return $file;
+ }
+
+ protected function compileEnum(proto\EnumDescriptorProto $enum, $ns)
+ {
+ $s = array();
+
+ $s[]= "namespace " . $this->normalizeNS($ns) . " {";
+ $s[]= "";
+ $s[]= " // @@protoc_insertion_point(scope_namespace)";
+ $s[]= " // @@protoc_insertion_point(namespace_$ns)";
+ $s[]= "";
+
+ $cmt = $this->compiler->getComment($ns . '.' . $enum->getName(), ' * ');
+ if ($cmt):
+ $s[]= " /**";
+ $s[]= $cmt;
+ $s[]= " */";
+ endif;
+
+ $s[]= " class " . $enum->getName() . " {";
+ foreach ($enum->getValueList() as $value):
+ $s[]= " const " . $value->getName() . " = " . $value->getNumber() . ";";
+ endforeach;
+ $s[]= "";
+ $s[]= " // @@protoc_insertion_point(scope_class)";
+ $s[]= ' // @@protoc_insertion_point(class_' . $ns . '.' . $enum->getName() . ')';
+ $s[]= " }";
+ $s[]= "}";
+ $s[]= "";
+
+ return implode(PHP_EOL, $s);
+ }
+
+ protected function compileMessage(proto\DescriptorProto $msg, $ns)
+ {
+ $s = array();
+ $s[]= "namespace " . $this->normalizeNS($ns) . " {";
+ $s[]= "";
+ $s[]= " // @@protoc_insertion_point(scope_namespace)";
+ $s[]= " // @@protoc_insertion_point(namespace_$ns)";
+ $s[]= "";
+
+ $cmt = $this->compiler->getComment($ns . '.' . $msg->getName(), ' * ');
+ if ($cmt):
+ $s[]= " /**";
+ $s[]= $cmt;
+ $s[]= " */";
+ endif;
+
+ // Compute a new namespace with the message name as suffix
+ $ns .= '.' . $msg->getName();
+
+ $s[]= ' class ' . $msg->getName() . ' extends \DrSlump\Protobuf\Message {';
+ $s[]= "";
+ $s[]= ' /** @var \Closure[] */';
+ $s[]= ' protected static $__extensions = array();';
+ $s[]= '';
+ $s[]= ' public static function descriptor()';
+ $s[]= ' {';
+ $s[]= ' $descriptor = new \DrSlump\Protobuf\Descriptor(__CLASS__, \'' . $ns . '\');';
+ $s[]= '';
+ foreach ($msg->getField() as $field):
+ $s[]= $this->compileField($field, $ns, " ");
+ $s[]= ' $descriptor->addField($f);';
+ $s[]= '';
+ endforeach;
+ $s[]= ' foreach (self::$__extensions as $cb) {';
+ $s[]= ' $descriptor->addField($cb(), true);';
+ $s[]= ' }';
+ $s[]= '';
+ $s[]= ' // @@protoc_insertion_point(scope_descriptor)';
+ $s[]= ' // @@protoc_insertion_point(descriptor_' . $ns . ')';
+ $s[]= '';
+ $s[]= ' return $descriptor;';
+ $s[]= ' }';
+ $s[]= '';
+
+ //$s[]= " protected static \$__exts = array(";
+ //foreach ($msg->getExtensionRange() as $range):
+ //$s[]= ' array(' . $range->getStart() . ', ' . ($range->getEnd()-1) . '),';
+ //endforeach;
+ //$s[]= " );";
+ //$s[]= "";
+
+ foreach ($msg->getField() as $field):
+ $s[]= $this->generatePublicField($field, $ns, " ");
+ endforeach;
+ $s[]= "";
+
+ foreach ($msg->getField() as $field):
+ $s[]= $this->generateAccessors($field, $ns, " ");
+ endforeach;
+
+ $s[]= "";
+ $s[]= " // @@protoc_insertion_point(scope_class)";
+ $s[]= ' // @@protoc_insertion_point(class_' . $ns . ')';
+ $s[]= " }";
+ $s[]= "}";
+ $s[]= "";
+
+ // Generate Enums
+ if ($msg->hasEnumType()):
+ foreach ($msg->getEnumType() as $enum):
+ $src = $this->compileEnum($enum, $ns);
+ $this->addComponent($ns, $enum->getName(), $src);
+ endforeach;
+ endif;
+
+ // Generate nested messages
+ if ($msg->hasNestedType()):
+ foreach ($msg->getNestedType() as $msg):
+ $src = $this->compileMessage($msg, $ns);
+ $this->addComponent($ns, $msg->getName(), $src);
+ endforeach;
+ endif;
+
+ // Collect extensions
+ if ($msg->hasExtension()) {
+ foreach ($msg->getExtensionList() as $field) {
+ $this->_extensions[$field->getExtendee()][] = array($ns, $field);
+ }
+ }
+
+ return implode(PHP_EOL, $s) . PHP_EOL;
+ }
+
+
+ protected function compileField(proto\FieldDescriptorProto $field, $ns, $indent)
+ {
+ switch ($field->getLabel()) {
+ case Protobuf::RULE_REQUIRED:
+ $rule = 'required';
+ break;
+ case Protobuf::RULE_OPTIONAL:
+ $rule = 'optional';
+ break;
+ case Protobuf::RULE_REPEATED:
+ $rule = 'repeated';
+ break;
+ }
+
+ $s[]= "// $rule " . $field->getTypeName() . " " . $field->getName() . " = " . $field->getNumber();
+ $s[]= '$f = new \DrSlump\Protobuf\Field();';
+ $s[]= '$f->number = ' . $field->getNumber() . ';';
+ $s[]= '$f->name = "'. $field->getName() . '";';
+ $s[]= '$f->type = ' . $field->getType() . ';';
+ $s[]= '$f->rule = ' . $field->getLabel() . ';';
+
+ if ($field->hasTypeName()):
+ $ref = $field->getTypeName();
+ if (substr($ref, 0, 1) !== '.') {
+ throw new \RuntimeException("Only fully qualified names are supported but found '$ref' at $ns");
+ }
+ $s[]= '$f->reference = \'\\' . $this->normalizeNS($ref) . "';";
+ endif;
+
+ if ($field->hasDefaultValue()):
+ switch ($field->getType()) {
+ case Protobuf::TYPE_BOOL:
+ $bool = filter_var($field->getDefaultValue(), FILTER_VALIDATE_BOOLEAN);
+ $s[]= '$f->default = ' . ($bool ? 'true' : 'false') . ';';
+ break;
+ case Protobuf::TYPE_STRING:
+ $s[]= '$f->default = "' . addcslashes($field->getDefaultValue(), '"\\') . '";';
+ break;
+ case Protobuf::TYPE_ENUM:
+ $value = '\\' . $this->normalizeNS($field->getTypeName()) . '::' . $field->getDefaultValue();
+ $s[]= '$f->default = ' . $value . ';';
+ break;
+ default: // Numbers
+ $s[]= '$f->default = ' . $field->getDefaultValue() . ';';
+ }
+ endif;
+
+ $s[]= '// @@protoc_insertion_point(scope_field)';
+ $s[]= '// @@protoc_insertion_point(field_' . $ns . ':' . $field->getName() . ')';
+
+ return $indent . implode(PHP_EOL.$indent, $s);
+ }
+
+ protected function compileExtension(proto\FieldDescriptorProto $field, $ns, $indent)
+ {
+ $extendee = $this->normalizeNS($field->getExtendee());
+ $name = $this->normalizeNS($ns . '.' . $field->getName());
+ $field->setName($name);
+
+ $s[]= "\\$extendee::extension(function(){";
+ $s[]= $this->compileField($field, $ns, $indent.' ');
+ $s[]= ' // @@protoc_insertion_point(scope_extension)';
+ $s[]= ' // @@protoc_insertion_point(extension_' . $ns . ':' . $field->getName() . ')';
+ $s[]= ' return $f;';
+ $s[]= "});";
+
+ return $indent . implode(PHP_EOL.$indent, $s);
+ }
+
+ protected function compileService(proto\ServiceDescriptorProto $service, $ns)
+ {
+ $s = array();
+ $s[]= 'namespace ' . $this->normalizeNS($ns) . ' {';
+ $s[]= '';
+ $s[]= " // @@protoc_insertion_point(scope_namespace)";
+ $s[]= " // @@protoc_insertion_point(namespace_$ns)";
+ $s[]= '';
+
+ $cmt = $this->compiler->getComment($ns . '.' . $service->getName(), ' * ');
+ if ($cmt):
+ $s[]= " /**";
+ $s[]= $cmt;
+ $s[]= " */";
+ endif;
+
+ $s[]= ' interface ' . $service->getName();
+ $s[]= ' {';
+ $s[]= ' // @@protoc_insertion_point(scope_interface)';
+ $s[]= ' // @@protoc_insertion_point(interface_' . $ns . '.' . $service->getName() . ')';
+ $s[]= '';
+
+ foreach ($service->getMethodList() as $method):
+ $s[]= ' /**';
+
+ $cmt = $this->compiler->getComment($ns . '.' . $service->getName() . '.' . $method->getName(), ' * ');
+ if ($cmt):
+ $s[]= $cmt;
+ $s[]= ' * ';
+ endif;
+
+ $s[]= ' * @param ' . $this->normalizeNS($method->getInputType()) . ' $input';
+ $s[]= ' * @return ' . $this->normalizeNS($method->getOutputType());
+ $s[]= ' */';
+ $s[]= ' public function ' . $method->getName() . '(' . $this->normalizeNS($method->getInputType()) . ' $input);';
+ $s[]= '';
+ endforeach;
+ $s[]= ' }';
+ $s[]= '}';
+ $s[]= '';
+
+ return implode(PHP_EOL, $s) . PHP_EOL;
+ }
+
+ protected function generatePublicField(proto\FieldDescriptorProto $field, $ns, $indent)
+ {
+ $cmt = $this->compiler->getComment($ns . '.' . $field->getNumber(), "$indent * ");
+ if ($cmt) {
+ $cmt = "\n" . $cmt . "\n$indent *";
+ }
+
+ if ($field->getLabel() === Protobuf::RULE_REPEATED) {
+ $s[]= "/** $cmt @var " . $this->getJavaDocType($field) . "[] " . ($cmt ? "\n$indent" : '') . " */";
+ $s[]= 'public $' . $field->getName() . " = array();";
+ } else {
+ $s[]= "/** $cmt @var " . $this->getJavaDocType($field) . ($cmt ? "\n$indent" : '') . " */";
+ $default = 'null';
+ if ($field->hasDefaultValue()) {
+ switch ($field->getType()) {
+ case Protobuf::TYPE_BOOL:
+ $default = $field->getDefaultValue() ? 'true' : 'false';
+ break;
+ case Protobuf::TYPE_STRING:
+ $default = '"' . addcslashes($field->getDefaultValue(), '"\\') . '"';
+ break;
+ case Protobuf::TYPE_ENUM:
+ $default = '\\' . $this->normalizeNS($field->getTypeName()) . '::' . $field->getDefaultValue();
+ break;
+ default: // Numbers
+ $default = $field->getDefaultValue();
+ }
+ }
+ $s[]= 'public $' . $field->getName() . ' = ' . $default . ';';
+ }
+ $s[]= "";
+
+ return $indent . implode(PHP_EOL.$indent, $s);
+ }
+
+ protected function generateAccessors(proto\FieldDescriptorProto $field, $ns, $indent)
+ {
+ $tag = $field->getNumber();
+ $name = $field->getName();
+ $camel = $this->compiler->camelize(ucfirst($name));
+
+ $typehint = '';
+ $typedoc = $this->getJavaDocType($field);
+ if (0 === strpos($typedoc, '\\')) {
+ $typehint = $typedoc;
+ }
+
+ // hasXXX
+ $s[]= "/**";
+ $s[]= " * Check if <$name> has a value";
+ $s[]= " *";
+ $s[]= " * @return boolean";
+ $s[]= " */";
+ $s[]= "public function has$camel(){";
+ $s[]= " return \$this->_has($tag);";
+ $s[]= "}";
+ $s[]= "";
+
+ // clearXXX
+ $s[]= "/**";
+ $s[]= " * Clear <$name> value";
+ $s[]= " *";
+ $s[]= " * @return \\" . $this->normalizeNS($ns);
+ $s[]= " */";
+ $s[]= "public function clear$camel(){";
+ $s[]= " return \$this->_clear($tag);";
+ $s[]= "}";
+ $s[]= "";
+
+
+ if ($field->getLabel() === Protobuf::RULE_REPEATED):
+
+ // getXXX
+ $s[]= "/**";
+ $s[]= " * Get <$name> value";
+ $s[]= " *";
+ $s[]= " * @param int \$idx";
+ $s[]= " * @return $typedoc";
+ $s[]= " */";
+ $s[]= "public function get$camel(\$idx = NULL){";
+ $s[]= " return \$this->_get($tag, \$idx);";
+ $s[]= "}";
+ $s[]= "";
+
+ // setXXX
+ $s[]= "/**";
+ $s[]= " * Set <$name> value";
+ $s[]= " *";
+ $s[]= " * @param $typedoc \$value";
+ $s[]= " * @return \\" . $this->normalizeNS($ns);
+ $s[]= " */";
+ $s[]= "public function set$camel($typehint \$value, \$idx = NULL){";
+ $s[]= " return \$this->_set($tag, \$value, \$idx);";
+ $s[]= "}";
+ $s[]= "";
+
+ $s[]= "/**";
+ $s[]= " * Get all elements of <$name>";
+ $s[]= " *";
+ $s[]= " * @return {$typedoc}[]";
+ $s[]= " */";
+ $s[]= "public function get{$camel}List(){";
+ $s[]= " return \$this->_get($tag);";
+ $s[]= "}";
+ $s[]= "";
+
+ $s[]= "/**";
+ $s[]= " * Add a new element to <$name>";
+ $s[]= " *";
+ $s[]= " * @param $typedoc \$value";
+ $s[]= " * @return \\" . $this->normalizeNS($ns);
+ $s[]= " */";
+ $s[]= "public function add$camel($typehint \$value){";
+ $s[]= " return \$this->_add($tag, \$value);";
+ $s[]= "}";
+ $s[]= "";
+
+ else:
+
+ // getXXX
+ $s[]= "/**";
+ $s[]= " * Get <$name> value";
+ $s[]= " *";
+ $s[]= " * @return $typedoc";
+ $s[]= " */";
+ $s[]= "public function get$camel(){";
+ $s[]= " return \$this->_get($tag);";
+ $s[]= "}";
+ $s[]= "";
+
+ // setXXX
+ $s[]= "/**";
+ $s[]= " * Set <$name> value";
+ $s[]= " *";
+ $s[]= " * @param $typedoc \$value";
+ $s[]= " * @return \\" . $this->normalizeNS($ns);
+ $s[]= " */";
+ $s[]= "public function set$camel($typehint \$value){";
+ $s[]= " return \$this->_set($tag, \$value);";
+ $s[]= "}";
+ $s[]= "";
+
+ endif;
+
+ return $indent . implode(PHP_EOL.$indent, $s);
+ }
+
+ protected function getJavaDocType(proto\FieldDescriptorProto $field)
+ {
+ switch ($field->getType()) {
+ case Protobuf::TYPE_DOUBLE:
+ case Protobuf::TYPE_FLOAT:
+ return 'float';
+ case Protobuf::TYPE_INT64:
+ case Protobuf::TYPE_UINT64:
+ case Protobuf::TYPE_INT32:
+ case Protobuf::TYPE_FIXED64:
+ case Protobuf::TYPE_FIXED32:
+ case Protobuf::TYPE_UINT32:
+ case Protobuf::TYPE_SFIXED32:
+ case Protobuf::TYPE_SFIXED64:
+ case Protobuf::TYPE_SINT32:
+ case Protobuf::TYPE_SINT64:
+ return 'int';
+ case Protobuf::TYPE_BOOL:
+ return 'boolean';
+ case Protobuf::TYPE_STRING:
+ return 'string';
+ case Protobuf::TYPE_MESSAGE:
+ return '\\' . $this->normalizeNS($field->getTypeName());
+ case Protobuf::TYPE_BYTES:
+ return 'string';
+ case Protobuf::TYPE_ENUM:
+ return 'int - \\' . $this->normalizeNS($field->getTypeName());
+
+ case Protobuf::TYPE_GROUP:
+ default:
+ return 'unknown';
+ }
+ }
+
+ protected function normalizeNS($package)
+ {
+ // Remove leading dot (used in references)
+ $package = ltrim($package, '.');
+
+ if ($this->compiler->hasPackage($package)) {
+ return $this->compiler->getPackage($package);
+ }
+
+ // Check the currently registered packages to find a root one
+ $found = null;
+ foreach ($this->compiler->getPackages() as $pkg=>$ns) {
+ // Keep only the longest match
+ if (0 === strpos($package, $pkg.'.') && strlen($found) < strlen($pkg)) {
+ $found = $pkg;
+ }
+ }
+
+ // If no matching package was found issue a warning and use the package name
+ if (!$found) {
+ $this->compiler->warning('Non tracked package name found "' . $package . '"');
+ $namespace = str_replace('.', '\\', $package);
+ } else {
+ // Complete the namespace with the remaining package
+ $namespace = $this->compiler->getPackage($found);
+ $namespace .= substr($package, strlen($found));
+ $namespace = str_replace('.', '\\', $namespace);
+ // Set the newly found namespace in the registry
+ $this->compiler->setPackage($package, $namespace);
+ }
+
+ return $namespace;
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/descriptor.pb.php
@@ -1,1 +1,4780 @@
-
+<?php
+// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin @package_version@
+// Source: descriptor.proto
+// Date: 2011-03-20 01:26:49
+
+namespace google\protobuf {
+
+ class FileDescriptorSet extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\FileDescriptorSet");
+
+ // repeated .google.protobuf.FileDescriptorProto file = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "file";
+ $f->nameOrig = "file";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\FileDescriptorProto";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\FileDescriptorProto[] */
+ public $file = array();
+
+
+ /**
+ * Check if <file> has a value
+ *
+ * @return boolean
+ */
+ public function hasFile(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <file> value
+ *
+ * @return \google\protobuf\FileDescriptorSet
+ */
+ public function clearFile(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <file> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function getFile($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <file> value
+ *
+ * @param \google\protobuf\FileDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorSet
+ */
+ public function setFile(\google\protobuf\FileDescriptorProto $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <file>
+ *
+ * @return \google\protobuf\FileDescriptorProto[]
+ */
+ public function getFileList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <file>
+ *
+ * @param \google\protobuf\FileDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorSet
+ */
+ public function addFile(\google\protobuf\FileDescriptorProto $value){
+ return $this->_add(1, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class FileDescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\FileDescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional package = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "package";
+ $f->nameOrig = "package";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated dependency = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "dependency";
+ $f->nameOrig = "dependency";
+ $f->type = 9;
+ $f->rule = 3;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.DescriptorProto message_type = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "message_type";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\DescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.EnumDescriptorProto enum_type = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "enum_type";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\EnumDescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.ServiceDescriptorProto service = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "service";
+ $f->nameOrig = "service";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\ServiceDescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.FieldDescriptorProto extension = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "extension";
+ $f->nameOrig = "extension";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\FieldDescriptorProto";
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.FileOptions options = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\FileOptions";
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.SourceCodeInfo source_code_info = 9
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 9;
+ $f->name = "source_code_info";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\SourceCodeInfo";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var string */
+ public $package = null;
+
+ /** @var string[] */
+ public $dependency = array();
+
+ /** @var \google\protobuf\DescriptorProto[] */
+ public $message_type = array();
+
+ /** @var \google\protobuf\EnumDescriptorProto[] */
+ public $enum_type = array();
+
+ /** @var \google\protobuf\ServiceDescriptorProto[] */
+ public $service = array();
+
+ /** @var \google\protobuf\FieldDescriptorProto[] */
+ public $extension = array();
+
+ /** @var \google\protobuf\FileOptions */
+ public $options = null;
+
+ /** @var \google\protobuf\SourceCodeInfo */
+ public $source_code_info = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <package> has a value
+ *
+ * @return boolean
+ */
+ public function hasPackage(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <package> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearPackage(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <package> value
+ *
+ * @return string
+ */
+ public function getPackage(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <package> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setPackage( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <dependency> has a value
+ *
+ * @return boolean
+ */
+ public function hasDependency(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <dependency> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearDependency(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <dependency> value
+ *
+ * @param int $idx
+ * @return string
+ */
+ public function getDependency($idx = NULL){
+ return $this->_get(3, $idx);
+ }
+
+ /**
+ * Set <dependency> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setDependency( $value, $idx = NULL){
+ return $this->_set(3, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <dependency>
+ *
+ * @return string[]
+ */
+ public function getDependencyList(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Add a new element to <dependency>
+ *
+ * @param string $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function addDependency( $value){
+ return $this->_add(3, $value);
+ }
+
+ /**
+ * Check if <message_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasMessageType(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <message_type> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearMessageType(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <message_type> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function getMessageType($idx = NULL){
+ return $this->_get(4, $idx);
+ }
+
+ /**
+ * Set <message_type> value
+ *
+ * @param \google\protobuf\DescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setMessageType(\google\protobuf\DescriptorProto $value, $idx = NULL){
+ return $this->_set(4, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <message_type>
+ *
+ * @return \google\protobuf\DescriptorProto[]
+ */
+ public function getMessageTypeList(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Add a new element to <message_type>
+ *
+ * @param \google\protobuf\DescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function addMessageType(\google\protobuf\DescriptorProto $value){
+ return $this->_add(4, $value);
+ }
+
+ /**
+ * Check if <enum_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasEnumType(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <enum_type> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearEnumType(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <enum_type> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function getEnumType($idx = NULL){
+ return $this->_get(5, $idx);
+ }
+
+ /**
+ * Set <enum_type> value
+ *
+ * @param \google\protobuf\EnumDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setEnumType(\google\protobuf\EnumDescriptorProto $value, $idx = NULL){
+ return $this->_set(5, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <enum_type>
+ *
+ * @return \google\protobuf\EnumDescriptorProto[]
+ */
+ public function getEnumTypeList(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Add a new element to <enum_type>
+ *
+ * @param \google\protobuf\EnumDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function addEnumType(\google\protobuf\EnumDescriptorProto $value){
+ return $this->_add(5, $value);
+ }
+
+ /**
+ * Check if <service> has a value
+ *
+ * @return boolean
+ */
+ public function hasService(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <service> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearService(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <service> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function getService($idx = NULL){
+ return $this->_get(6, $idx);
+ }
+
+ /**
+ * Set <service> value
+ *
+ * @param \google\protobuf\ServiceDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setService(\google\protobuf\ServiceDescriptorProto $value, $idx = NULL){
+ return $this->_set(6, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <service>
+ *
+ * @return \google\protobuf\ServiceDescriptorProto[]
+ */
+ public function getServiceList(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Add a new element to <service>
+ *
+ * @param \google\protobuf\ServiceDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function addService(\google\protobuf\ServiceDescriptorProto $value){
+ return $this->_add(6, $value);
+ }
+
+ /**
+ * Check if <extension> has a value
+ *
+ * @return boolean
+ */
+ public function hasExtension(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <extension> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearExtension(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <extension> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function getExtension($idx = NULL){
+ return $this->_get(7, $idx);
+ }
+
+ /**
+ * Set <extension> value
+ *
+ * @param \google\protobuf\FieldDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setExtension(\google\protobuf\FieldDescriptorProto $value, $idx = NULL){
+ return $this->_set(7, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <extension>
+ *
+ * @return \google\protobuf\FieldDescriptorProto[]
+ */
+ public function getExtensionList(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Add a new element to <extension>
+ *
+ * @param \google\protobuf\FieldDescriptorProto $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function addExtension(\google\protobuf\FieldDescriptorProto $value){
+ return $this->_add(7, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function getOptions(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\FileOptions $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setOptions(\google\protobuf\FileOptions $value){
+ return $this->_set(8, $value);
+ }
+
+ /**
+ * Check if <source_code_info> has a value
+ *
+ * @return boolean
+ */
+ public function hasSourceCodeInfo(){
+ return $this->_has(9);
+ }
+
+ /**
+ * Clear <source_code_info> value
+ *
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function clearSourceCodeInfo(){
+ return $this->_clear(9);
+ }
+
+ /**
+ * Get <source_code_info> value
+ *
+ * @return \google\protobuf\SourceCodeInfo
+ */
+ public function getSourceCodeInfo(){
+ return $this->_get(9);
+ }
+
+ /**
+ * Set <source_code_info> value
+ *
+ * @param \google\protobuf\SourceCodeInfo $value
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function setSourceCodeInfo(\google\protobuf\SourceCodeInfo $value){
+ return $this->_set(9, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class DescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\DescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.FieldDescriptorProto field = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "field";
+ $f->nameOrig = "field";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\FieldDescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.FieldDescriptorProto extension = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "extension";
+ $f->nameOrig = "extension";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\FieldDescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.DescriptorProto nested_type = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "nested_type";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\DescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.EnumDescriptorProto enum_type = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "enum_type";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\EnumDescriptorProto";
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.DescriptorProto.ExtensionRange extension_range = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "extension_range";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\DescriptorProto\ExtensionRange";
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.MessageOptions options = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\MessageOptions";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var \google\protobuf\FieldDescriptorProto[] */
+ public $field = array();
+
+ /** @var \google\protobuf\FieldDescriptorProto[] */
+ public $extension = array();
+
+ /** @var \google\protobuf\DescriptorProto[] */
+ public $nested_type = array();
+
+ /** @var \google\protobuf\EnumDescriptorProto[] */
+ public $enum_type = array();
+
+ /** @var \google\protobuf\DescriptorProto\ExtensionRange[] */
+ public $extension_range = array();
+
+ /** @var \google\protobuf\MessageOptions */
+ public $options = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <field> has a value
+ *
+ * @return boolean
+ */
+ public function hasField(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <field> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearField(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <field> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function getField($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <field> value
+ *
+ * @param \google\protobuf\FieldDescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setField(\google\protobuf\FieldDescriptorProto $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <field>
+ *
+ * @return \google\protobuf\FieldDescriptorProto[]
+ */
+ public function getFieldList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <field>
+ *
+ * @param \google\protobuf\FieldDescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function addField(\google\protobuf\FieldDescriptorProto $value){
+ return $this->_add(2, $value);
+ }
+
+ /**
+ * Check if <extension> has a value
+ *
+ * @return boolean
+ */
+ public function hasExtension(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <extension> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearExtension(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <extension> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function getExtension($idx = NULL){
+ return $this->_get(6, $idx);
+ }
+
+ /**
+ * Set <extension> value
+ *
+ * @param \google\protobuf\FieldDescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setExtension(\google\protobuf\FieldDescriptorProto $value, $idx = NULL){
+ return $this->_set(6, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <extension>
+ *
+ * @return \google\protobuf\FieldDescriptorProto[]
+ */
+ public function getExtensionList(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Add a new element to <extension>
+ *
+ * @param \google\protobuf\FieldDescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function addExtension(\google\protobuf\FieldDescriptorProto $value){
+ return $this->_add(6, $value);
+ }
+
+ /**
+ * Check if <nested_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasNestedType(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <nested_type> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearNestedType(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <nested_type> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function getNestedType($idx = NULL){
+ return $this->_get(3, $idx);
+ }
+
+ /**
+ * Set <nested_type> value
+ *
+ * @param \google\protobuf\DescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setNestedType(\google\protobuf\DescriptorProto $value, $idx = NULL){
+ return $this->_set(3, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <nested_type>
+ *
+ * @return \google\protobuf\DescriptorProto[]
+ */
+ public function getNestedTypeList(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Add a new element to <nested_type>
+ *
+ * @param \google\protobuf\DescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function addNestedType(\google\protobuf\DescriptorProto $value){
+ return $this->_add(3, $value);
+ }
+
+ /**
+ * Check if <enum_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasEnumType(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <enum_type> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearEnumType(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <enum_type> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function getEnumType($idx = NULL){
+ return $this->_get(4, $idx);
+ }
+
+ /**
+ * Set <enum_type> value
+ *
+ * @param \google\protobuf\EnumDescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setEnumType(\google\protobuf\EnumDescriptorProto $value, $idx = NULL){
+ return $this->_set(4, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <enum_type>
+ *
+ * @return \google\protobuf\EnumDescriptorProto[]
+ */
+ public function getEnumTypeList(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Add a new element to <enum_type>
+ *
+ * @param \google\protobuf\EnumDescriptorProto $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function addEnumType(\google\protobuf\EnumDescriptorProto $value){
+ return $this->_add(4, $value);
+ }
+
+ /**
+ * Check if <extension_range> has a value
+ *
+ * @return boolean
+ */
+ public function hasExtensionRange(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <extension_range> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearExtensionRange(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <extension_range> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\DescriptorProto\ExtensionRange
+ */
+ public function getExtensionRange($idx = NULL){
+ return $this->_get(5, $idx);
+ }
+
+ /**
+ * Set <extension_range> value
+ *
+ * @param \google\protobuf\DescriptorProto\ExtensionRange $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setExtensionRange(\google\protobuf\DescriptorProto\ExtensionRange $value, $idx = NULL){
+ return $this->_set(5, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <extension_range>
+ *
+ * @return \google\protobuf\DescriptorProto\ExtensionRange[]
+ */
+ public function getExtensionRangeList(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Add a new element to <extension_range>
+ *
+ * @param \google\protobuf\DescriptorProto\ExtensionRange $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function addExtensionRange(\google\protobuf\DescriptorProto\ExtensionRange $value){
+ return $this->_add(5, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\MessageOptions
+ */
+ public function getOptions(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\MessageOptions $value
+ * @return \google\protobuf\DescriptorProto
+ */
+ public function setOptions(\google\protobuf\MessageOptions $value){
+ return $this->_set(7, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\DescriptorProto {
+
+ class ExtensionRange extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\DescriptorProto\ExtensionRange");
+
+ // optional start = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "start";
+ $f->nameOrig = "start";
+ $f->type = 5;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional end = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "end";
+ $f->nameOrig = "end";
+ $f->type = 5;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var int */
+ public $start = null;
+
+ /** @var int */
+ public $end = null;
+
+
+ /**
+ * Check if <start> has a value
+ *
+ * @return boolean
+ */
+ public function hasStart(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <start> value
+ *
+ * @return \google\protobuf\DescriptorProto\ExtensionRange
+ */
+ public function clearStart(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <start> value
+ *
+ * @return int
+ */
+ public function getStart(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <start> value
+ *
+ * @param int $value
+ * @return \google\protobuf\DescriptorProto\ExtensionRange
+ */
+ public function setStart( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <end> has a value
+ *
+ * @return boolean
+ */
+ public function hasEnd(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <end> value
+ *
+ * @return \google\protobuf\DescriptorProto\ExtensionRange
+ */
+ public function clearEnd(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <end> value
+ *
+ * @return int
+ */
+ public function getEnd(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <end> value
+ *
+ * @param int $value
+ * @return \google\protobuf\DescriptorProto\ExtensionRange
+ */
+ public function setEnd( $value){
+ return $this->_set(2, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class FieldDescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\FieldDescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional number = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "number";
+ $f->nameOrig = "number";
+ $f->type = 5;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.FieldDescriptorProto.Label label = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "label";
+ $f->nameOrig = "label";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\FieldDescriptorProto\Label";
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.FieldDescriptorProto.Type type = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "type";
+ $f->nameOrig = "type";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\FieldDescriptorProto\Type";
+ $descriptor->addField($f);
+
+ // optional type_name = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "type_name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional extendee = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "extendee";
+ $f->nameOrig = "extendee";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional default_value = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "default_value";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.FieldOptions options = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\FieldOptions";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var int */
+ public $number = null;
+
+ /** @var int - \google\protobuf\FieldDescriptorProto\Label */
+ public $label = null;
+
+ /** @var int - \google\protobuf\FieldDescriptorProto\Type */
+ public $type = null;
+
+ /** @var string */
+ public $type_name = null;
+
+ /** @var string */
+ public $extendee = null;
+
+ /** @var string */
+ public $default_value = null;
+
+ /** @var \google\protobuf\FieldOptions */
+ public $options = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <number> has a value
+ *
+ * @return boolean
+ */
+ public function hasNumber(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <number> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearNumber(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <number> value
+ *
+ * @return int
+ */
+ public function getNumber(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <number> value
+ *
+ * @param int $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setNumber( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <label> has a value
+ *
+ * @return boolean
+ */
+ public function hasLabel(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <label> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearLabel(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <label> value
+ *
+ * @return int - \google\protobuf\FieldDescriptorProto\Label
+ */
+ public function getLabel(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <label> value
+ *
+ * @param int - \google\protobuf\FieldDescriptorProto\Label $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setLabel( $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <type> has a value
+ *
+ * @return boolean
+ */
+ public function hasType(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <type> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearType(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <type> value
+ *
+ * @return int - \google\protobuf\FieldDescriptorProto\Type
+ */
+ public function getType(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <type> value
+ *
+ * @param int - \google\protobuf\FieldDescriptorProto\Type $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setType( $value){
+ return $this->_set(5, $value);
+ }
+
+ /**
+ * Check if <type_name> has a value
+ *
+ * @return boolean
+ */
+ public function hasTypeName(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <type_name> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearTypeName(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <type_name> value
+ *
+ * @return string
+ */
+ public function getTypeName(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Set <type_name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setTypeName( $value){
+ return $this->_set(6, $value);
+ }
+
+ /**
+ * Check if <extendee> has a value
+ *
+ * @return boolean
+ */
+ public function hasExtendee(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <extendee> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearExtendee(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <extendee> value
+ *
+ * @return string
+ */
+ public function getExtendee(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <extendee> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setExtendee( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <default_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasDefaultValue(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <default_value> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearDefaultValue(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <default_value> value
+ *
+ * @return string
+ */
+ public function getDefaultValue(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Set <default_value> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setDefaultValue( $value){
+ return $this->_set(7, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\FieldOptions
+ */
+ public function getOptions(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\FieldOptions $value
+ * @return \google\protobuf\FieldDescriptorProto
+ */
+ public function setOptions(\google\protobuf\FieldOptions $value){
+ return $this->_set(8, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\FieldDescriptorProto {
+
+ class Type {
+ const TYPE_DOUBLE = 1;
+ const TYPE_FLOAT = 2;
+ const TYPE_INT64 = 3;
+ const TYPE_UINT64 = 4;
+ const TYPE_INT32 = 5;
+ const TYPE_FIXED64 = 6;
+ const TYPE_FIXED32 = 7;
+ const TYPE_BOOL = 8;
+ const TYPE_STRING = 9;
+ const TYPE_GROUP = 10;
+ const TYPE_MESSAGE = 11;
+ const TYPE_BYTES = 12;
+ const TYPE_UINT32 = 13;
+ const TYPE_ENUM = 14;
+ const TYPE_SFIXED32 = 15;
+ const TYPE_SFIXED64 = 16;
+ const TYPE_SINT32 = 17;
+ const TYPE_SINT64 = 18;
+ }
+}
+
+namespace google\protobuf\FieldDescriptorProto {
+
+ class Label {
+ const LABEL_OPTIONAL = 1;
+ const LABEL_REQUIRED = 2;
+ const LABEL_REPEATED = 3;
+ }
+}
+
+namespace google\protobuf {
+
+ class EnumDescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\EnumDescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.EnumValueDescriptorProto value = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "value";
+ $f->nameOrig = "value";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\EnumValueDescriptorProto";
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.EnumOptions options = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\EnumOptions";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var \google\protobuf\EnumValueDescriptorProto[] */
+ public $value = array();
+
+ /** @var \google\protobuf\EnumOptions */
+ public $options = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <value> has a value
+ *
+ * @return boolean
+ */
+ public function hasValue(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <value> value
+ *
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function clearValue(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <value> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function getValue($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <value> value
+ *
+ * @param \google\protobuf\EnumValueDescriptorProto $value
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function setValue(\google\protobuf\EnumValueDescriptorProto $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <value>
+ *
+ * @return \google\protobuf\EnumValueDescriptorProto[]
+ */
+ public function getValueList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <value>
+ *
+ * @param \google\protobuf\EnumValueDescriptorProto $value
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function addValue(\google\protobuf\EnumValueDescriptorProto $value){
+ return $this->_add(2, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\EnumOptions
+ */
+ public function getOptions(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\EnumOptions $value
+ * @return \google\protobuf\EnumDescriptorProto
+ */
+ public function setOptions(\google\protobuf\EnumOptions $value){
+ return $this->_set(3, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class EnumValueDescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\EnumValueDescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional number = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "number";
+ $f->nameOrig = "number";
+ $f->type = 5;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.EnumValueOptions options = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\EnumValueOptions";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var int */
+ public $number = null;
+
+ /** @var \google\protobuf\EnumValueOptions */
+ public $options = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <number> has a value
+ *
+ * @return boolean
+ */
+ public function hasNumber(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <number> value
+ *
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function clearNumber(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <number> value
+ *
+ * @return int
+ */
+ public function getNumber(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <number> value
+ *
+ * @param int $value
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function setNumber( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\EnumValueOptions
+ */
+ public function getOptions(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\EnumValueOptions $value
+ * @return \google\protobuf\EnumValueDescriptorProto
+ */
+ public function setOptions(\google\protobuf\EnumValueOptions $value){
+ return $this->_set(3, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class ServiceDescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\ServiceDescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.MethodDescriptorProto method = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "method";
+ $f->nameOrig = "method";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\MethodDescriptorProto";
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.ServiceOptions options = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\ServiceOptions";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var \google\protobuf\MethodDescriptorProto[] */
+ public $method = array();
+
+ /** @var \google\protobuf\ServiceOptions */
+ public $options = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <method> has a value
+ *
+ * @return boolean
+ */
+ public function hasMethod(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <method> value
+ *
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function clearMethod(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <method> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function getMethod($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <method> value
+ *
+ * @param \google\protobuf\MethodDescriptorProto $value
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function setMethod(\google\protobuf\MethodDescriptorProto $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <method>
+ *
+ * @return \google\protobuf\MethodDescriptorProto[]
+ */
+ public function getMethodList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <method>
+ *
+ * @param \google\protobuf\MethodDescriptorProto $value
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function addMethod(\google\protobuf\MethodDescriptorProto $value){
+ return $this->_add(2, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\ServiceOptions
+ */
+ public function getOptions(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\ServiceOptions $value
+ * @return \google\protobuf\ServiceDescriptorProto
+ */
+ public function setOptions(\google\protobuf\ServiceOptions $value){
+ return $this->_set(3, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class MethodDescriptorProto extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\MethodDescriptorProto");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional input_type = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "input_type";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional output_type = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "output_type";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.MethodOptions options = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "options";
+ $f->nameOrig = "options";
+ $f->type = 11;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\MethodOptions";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var string */
+ public $input_type = null;
+
+ /** @var string */
+ public $output_type = null;
+
+ /** @var \google\protobuf\MethodOptions */
+ public $options = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <input_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasInputType(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <input_type> value
+ *
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function clearInputType(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <input_type> value
+ *
+ * @return string
+ */
+ public function getInputType(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <input_type> value
+ *
+ * @param string $value
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function setInputType( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <output_type> has a value
+ *
+ * @return boolean
+ */
+ public function hasOutputType(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <output_type> value
+ *
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function clearOutputType(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <output_type> value
+ *
+ * @return string
+ */
+ public function getOutputType(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <output_type> value
+ *
+ * @param string $value
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function setOutputType( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <options> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptions(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <options> value
+ *
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function clearOptions(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <options> value
+ *
+ * @return \google\protobuf\MethodOptions
+ */
+ public function getOptions(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <options> value
+ *
+ * @param \google\protobuf\MethodOptions $value
+ * @return \google\protobuf\MethodDescriptorProto
+ */
+ public function setOptions(\google\protobuf\MethodOptions $value){
+ return $this->_set(4, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class FileOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\FileOptions");
+
+ // optional java_package = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "java_package";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional java_outer_classname = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "java_outer_classname";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional java_multiple_files = 10
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 10;
+ $f->name = "java_multiple_files";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // optional java_generate_equals_and_hash = 20
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 20;
+ $f->name = "java_generate_equals_and_hash";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // optional .google.protobuf.FileOptions.OptimizeMode optimize_for = 9
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 9;
+ $f->name = "optimize_for";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\FileOptions\OptimizeMode";
+ $f->default = "SPEED";
+ $descriptor->addField($f);
+
+ // optional cc_generic_services = 16
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 16;
+ $f->name = "cc_generic_services";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // optional java_generic_services = 17
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 17;
+ $f->name = "java_generic_services";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // optional py_generic_services = 18
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 18;
+ $f->name = "py_generic_services";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $java_package = null;
+
+ /** @var string */
+ public $java_outer_classname = null;
+
+ /** @var boolean */
+ public $java_multiple_files = true;
+
+ /** @var boolean */
+ public $java_generate_equals_and_hash = true;
+
+ /** @var int - \google\protobuf\FileOptions\OptimizeMode */
+ public $optimize_for = "SPEED";
+
+ /** @var boolean */
+ public $cc_generic_services = true;
+
+ /** @var boolean */
+ public $java_generic_services = true;
+
+ /** @var boolean */
+ public $py_generic_services = true;
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <java_package> has a value
+ *
+ * @return boolean
+ */
+ public function hasJavaPackage(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <java_package> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearJavaPackage(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <java_package> value
+ *
+ * @return string
+ */
+ public function getJavaPackage(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <java_package> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setJavaPackage( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <java_outer_classname> has a value
+ *
+ * @return boolean
+ */
+ public function hasJavaOuterClassname(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <java_outer_classname> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearJavaOuterClassname(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <java_outer_classname> value
+ *
+ * @return string
+ */
+ public function getJavaOuterClassname(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <java_outer_classname> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setJavaOuterClassname( $value){
+ return $this->_set(8, $value);
+ }
+
+ /**
+ * Check if <java_multiple_files> has a value
+ *
+ * @return boolean
+ */
+ public function hasJavaMultipleFiles(){
+ return $this->_has(10);
+ }
+
+ /**
+ * Clear <java_multiple_files> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearJavaMultipleFiles(){
+ return $this->_clear(10);
+ }
+
+ /**
+ * Get <java_multiple_files> value
+ *
+ * @return boolean
+ */
+ public function getJavaMultipleFiles(){
+ return $this->_get(10);
+ }
+
+ /**
+ * Set <java_multiple_files> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setJavaMultipleFiles( $value){
+ return $this->_set(10, $value);
+ }
+
+ /**
+ * Check if <java_generate_equals_and_hash> has a value
+ *
+ * @return boolean
+ */
+ public function hasJavaGenerateEqualsAndHash(){
+ return $this->_has(20);
+ }
+
+ /**
+ * Clear <java_generate_equals_and_hash> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearJavaGenerateEqualsAndHash(){
+ return $this->_clear(20);
+ }
+
+ /**
+ * Get <java_generate_equals_and_hash> value
+ *
+ * @return boolean
+ */
+ public function getJavaGenerateEqualsAndHash(){
+ return $this->_get(20);
+ }
+
+ /**
+ * Set <java_generate_equals_and_hash> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setJavaGenerateEqualsAndHash( $value){
+ return $this->_set(20, $value);
+ }
+
+ /**
+ * Check if <optimize_for> has a value
+ *
+ * @return boolean
+ */
+ public function hasOptimizeFor(){
+ return $this->_has(9);
+ }
+
+ /**
+ * Clear <optimize_for> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearOptimizeFor(){
+ return $this->_clear(9);
+ }
+
+ /**
+ * Get <optimize_for> value
+ *
+ * @return int - \google\protobuf\FileOptions\OptimizeMode
+ */
+ public function getOptimizeFor(){
+ return $this->_get(9);
+ }
+
+ /**
+ * Set <optimize_for> value
+ *
+ * @param int - \google\protobuf\FileOptions\OptimizeMode $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setOptimizeFor( $value){
+ return $this->_set(9, $value);
+ }
+
+ /**
+ * Check if <cc_generic_services> has a value
+ *
+ * @return boolean
+ */
+ public function hasCcGenericServices(){
+ return $this->_has(16);
+ }
+
+ /**
+ * Clear <cc_generic_services> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearCcGenericServices(){
+ return $this->_clear(16);
+ }
+
+ /**
+ * Get <cc_generic_services> value
+ *
+ * @return boolean
+ */
+ public function getCcGenericServices(){
+ return $this->_get(16);
+ }
+
+ /**
+ * Set <cc_generic_services> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setCcGenericServices( $value){
+ return $this->_set(16, $value);
+ }
+
+ /**
+ * Check if <java_generic_services> has a value
+ *
+ * @return boolean
+ */
+ public function hasJavaGenericServices(){
+ return $this->_has(17);
+ }
+
+ /**
+ * Clear <java_generic_services> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearJavaGenericServices(){
+ return $this->_clear(17);
+ }
+
+ /**
+ * Get <java_generic_services> value
+ *
+ * @return boolean
+ */
+ public function getJavaGenericServices(){
+ return $this->_get(17);
+ }
+
+ /**
+ * Set <java_generic_services> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setJavaGenericServices( $value){
+ return $this->_set(17, $value);
+ }
+
+ /**
+ * Check if <py_generic_services> has a value
+ *
+ * @return boolean
+ */
+ public function hasPyGenericServices(){
+ return $this->_has(18);
+ }
+
+ /**
+ * Clear <py_generic_services> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearPyGenericServices(){
+ return $this->_clear(18);
+ }
+
+ /**
+ * Get <py_generic_services> value
+ *
+ * @return boolean
+ */
+ public function getPyGenericServices(){
+ return $this->_get(18);
+ }
+
+ /**
+ * Set <py_generic_services> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setPyGenericServices( $value){
+ return $this->_set(18, $value);
+ }
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\FileOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\FileOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\FileOptions {
+
+ class OptimizeMode {
+ const SPEED = 1;
+ const CODE_SIZE = 2;
+ const LITE_RUNTIME = 3;
+ }
+}
+
+namespace google\protobuf {
+
+ class MessageOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\MessageOptions");
+
+ // optional message_set_wire_format = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "message_set_wire_format";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // optional no_standard_descriptor_accessor = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "no_standard_descriptor_accessor";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var boolean */
+ public $message_set_wire_format = true;
+
+ /** @var boolean */
+ public $no_standard_descriptor_accessor = true;
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <message_set_wire_format> has a value
+ *
+ * @return boolean
+ */
+ public function hasMessageSetWireFormat(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <message_set_wire_format> value
+ *
+ * @return \google\protobuf\MessageOptions
+ */
+ public function clearMessageSetWireFormat(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <message_set_wire_format> value
+ *
+ * @return boolean
+ */
+ public function getMessageSetWireFormat(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <message_set_wire_format> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\MessageOptions
+ */
+ public function setMessageSetWireFormat( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <no_standard_descriptor_accessor> has a value
+ *
+ * @return boolean
+ */
+ public function hasNoStandardDescriptorAccessor(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <no_standard_descriptor_accessor> value
+ *
+ * @return \google\protobuf\MessageOptions
+ */
+ public function clearNoStandardDescriptorAccessor(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <no_standard_descriptor_accessor> value
+ *
+ * @return boolean
+ */
+ public function getNoStandardDescriptorAccessor(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <no_standard_descriptor_accessor> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\MessageOptions
+ */
+ public function setNoStandardDescriptorAccessor( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\MessageOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\MessageOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\MessageOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class FieldOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\FieldOptions");
+
+ // optional .google.protobuf.FieldOptions.CType ctype = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "ctype";
+ $f->nameOrig = "ctype";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = "\google\protobuf\FieldOptions\CType";
+ $f->default = "STRING";
+ $descriptor->addField($f);
+
+ // optional packed = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "packed";
+ $f->nameOrig = "packed";
+ $f->type = 8;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional deprecated = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "deprecated";
+ $f->nameOrig = "deprecated";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = true;
+ $descriptor->addField($f);
+
+ // optional experimental_map_key = 9
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 9;
+ $f->name = "experimental_map_key";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var int - \google\protobuf\FieldOptions\CType */
+ public $ctype = "STRING";
+
+ /** @var boolean */
+ public $packed = null;
+
+ /** @var boolean */
+ public $deprecated = true;
+
+ /** @var string */
+ public $experimental_map_key = null;
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <ctype> has a value
+ *
+ * @return boolean
+ */
+ public function hasCtype(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <ctype> value
+ *
+ * @return \google\protobuf\FieldOptions
+ */
+ public function clearCtype(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <ctype> value
+ *
+ * @return int - \google\protobuf\FieldOptions\CType
+ */
+ public function getCtype(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <ctype> value
+ *
+ * @param int - \google\protobuf\FieldOptions\CType $value
+ * @return \google\protobuf\FieldOptions
+ */
+ public function setCtype( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <packed> has a value
+ *
+ * @return boolean
+ */
+ public function hasPacked(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <packed> value
+ *
+ * @return \google\protobuf\FieldOptions
+ */
+ public function clearPacked(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <packed> value
+ *
+ * @return boolean
+ */
+ public function getPacked(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <packed> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FieldOptions
+ */
+ public function setPacked( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <deprecated> has a value
+ *
+ * @return boolean
+ */
+ public function hasDeprecated(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <deprecated> value
+ *
+ * @return \google\protobuf\FieldOptions
+ */
+ public function clearDeprecated(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <deprecated> value
+ *
+ * @return boolean
+ */
+ public function getDeprecated(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <deprecated> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\FieldOptions
+ */
+ public function setDeprecated( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <experimental_map_key> has a value
+ *
+ * @return boolean
+ */
+ public function hasExperimentalMapKey(){
+ return $this->_has(9);
+ }
+
+ /**
+ * Clear <experimental_map_key> value
+ *
+ * @return \google\protobuf\FieldOptions
+ */
+ public function clearExperimentalMapKey(){
+ return $this->_clear(9);
+ }
+
+ /**
+ * Get <experimental_map_key> value
+ *
+ * @return string
+ */
+ public function getExperimentalMapKey(){
+ return $this->_get(9);
+ }
+
+ /**
+ * Set <experimental_map_key> value
+ *
+ * @param string $value
+ * @return \google\protobuf\FieldOptions
+ */
+ public function setExperimentalMapKey( $value){
+ return $this->_set(9, $value);
+ }
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\FieldOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\FieldOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\FieldOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\FieldOptions {
+
+ class CType {
+ const STRING = 0;
+ const CORD = 1;
+ const STRING_PIECE = 2;
+ }
+}
+
+namespace google\protobuf {
+
+ class EnumOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\EnumOptions");
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\EnumOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\EnumOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\EnumOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class EnumValueOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\EnumValueOptions");
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\EnumValueOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\EnumValueOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\EnumValueOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class ServiceOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\ServiceOptions");
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\ServiceOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\ServiceOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\ServiceOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class MethodOptions extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\MethodOptions");
+
+ // repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 999;
+ $f->name = "uninterpreted_option";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\UninterpretedOption[] */
+ public $uninterpreted_option = array();
+
+
+ /**
+ * Check if <uninterpreted_option> has a value
+ *
+ * @return boolean
+ */
+ public function hasUninterpretedOption(){
+ return $this->_has(999);
+ }
+
+ /**
+ * Clear <uninterpreted_option> value
+ *
+ * @return \google\protobuf\MethodOptions
+ */
+ public function clearUninterpretedOption(){
+ return $this->_clear(999);
+ }
+
+ /**
+ * Get <uninterpreted_option> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function getUninterpretedOption($idx = NULL){
+ return $this->_get(999, $idx);
+ }
+
+ /**
+ * Set <uninterpreted_option> value
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\MethodOptions
+ */
+ public function setUninterpretedOption(\google\protobuf\UninterpretedOption $value, $idx = NULL){
+ return $this->_set(999, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <uninterpreted_option>
+ *
+ * @return \google\protobuf\UninterpretedOption[]
+ */
+ public function getUninterpretedOptionList(){
+ return $this->_get(999);
+ }
+
+ /**
+ * Add a new element to <uninterpreted_option>
+ *
+ * @param \google\protobuf\UninterpretedOption $value
+ * @return \google\protobuf\MethodOptions
+ */
+ public function addUninterpretedOption(\google\protobuf\UninterpretedOption $value){
+ return $this->_add(999, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class UninterpretedOption extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\UninterpretedOption");
+
+ // repeated .google.protobuf.UninterpretedOption.NamePart name = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\UninterpretedOption\NamePart";
+ $descriptor->addField($f);
+
+ // optional identifier_value = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "identifier_value";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional positive_int_value = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "positive_int_value";
+ $f->type = 4;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional negative_int_value = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "negative_int_value";
+ $f->type = 3;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional double_value = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "double_value";
+ $f->type = 1;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional string_value = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "string_value";
+ $f->type = 12;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional aggregate_value = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "aggregate_value";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\UninterpretedOption\NamePart[] */
+ public $name = array();
+
+ /** @var string */
+ public $identifier_value = null;
+
+ /** @var int */
+ public $positive_int_value = null;
+
+ /** @var int */
+ public $negative_int_value = null;
+
+ /** @var float */
+ public $double_value = null;
+
+ /** @var string */
+ public $string_value = null;
+
+ /** @var string */
+ public $aggregate_value = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearName(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\UninterpretedOption\NamePart
+ */
+ public function getName($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param \google\protobuf\UninterpretedOption\NamePart $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setName(\google\protobuf\UninterpretedOption\NamePart $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <name>
+ *
+ * @return \google\protobuf\UninterpretedOption\NamePart[]
+ */
+ public function getNameList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <name>
+ *
+ * @param \google\protobuf\UninterpretedOption\NamePart $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function addName(\google\protobuf\UninterpretedOption\NamePart $value){
+ return $this->_add(2, $value);
+ }
+
+ /**
+ * Check if <identifier_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasIdentifierValue(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <identifier_value> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearIdentifierValue(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <identifier_value> value
+ *
+ * @return string
+ */
+ public function getIdentifierValue(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <identifier_value> value
+ *
+ * @param string $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setIdentifierValue( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <positive_int_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasPositiveIntValue(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <positive_int_value> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearPositiveIntValue(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <positive_int_value> value
+ *
+ * @return int
+ */
+ public function getPositiveIntValue(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <positive_int_value> value
+ *
+ * @param int $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setPositiveIntValue( $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <negative_int_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasNegativeIntValue(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <negative_int_value> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearNegativeIntValue(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <negative_int_value> value
+ *
+ * @return int
+ */
+ public function getNegativeIntValue(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <negative_int_value> value
+ *
+ * @param int $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setNegativeIntValue( $value){
+ return $this->_set(5, $value);
+ }
+
+ /**
+ * Check if <double_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasDoubleValue(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <double_value> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearDoubleValue(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <double_value> value
+ *
+ * @return float
+ */
+ public function getDoubleValue(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Set <double_value> value
+ *
+ * @param float $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setDoubleValue( $value){
+ return $this->_set(6, $value);
+ }
+
+ /**
+ * Check if <string_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasStringValue(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <string_value> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearStringValue(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <string_value> value
+ *
+ * @return string
+ */
+ public function getStringValue(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Set <string_value> value
+ *
+ * @param string $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setStringValue( $value){
+ return $this->_set(7, $value);
+ }
+
+ /**
+ * Check if <aggregate_value> has a value
+ *
+ * @return boolean
+ */
+ public function hasAggregateValue(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <aggregate_value> value
+ *
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function clearAggregateValue(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <aggregate_value> value
+ *
+ * @return string
+ */
+ public function getAggregateValue(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <aggregate_value> value
+ *
+ * @param string $value
+ * @return \google\protobuf\UninterpretedOption
+ */
+ public function setAggregateValue( $value){
+ return $this->_set(8, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\UninterpretedOption {
+
+ class NamePart extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\UninterpretedOption\NamePart");
+
+ // required name_part = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name_part";
+ $f->type = 9;
+ $f->rule = 2;
+ $descriptor->addField($f);
+
+ // required is_extension = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "is_extension";
+ $f->type = 8;
+ $f->rule = 2;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name_part = null;
+
+ /** @var boolean */
+ public $is_extension = null;
+
+
+ /**
+ * Check if <name_part> has a value
+ *
+ * @return boolean
+ */
+ public function hasNamePart(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name_part> value
+ *
+ * @return \google\protobuf\UninterpretedOption\NamePart
+ */
+ public function clearNamePart(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name_part> value
+ *
+ * @return string
+ */
+ public function getNamePart(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name_part> value
+ *
+ * @param string $value
+ * @return \google\protobuf\UninterpretedOption\NamePart
+ */
+ public function setNamePart( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <is_extension> has a value
+ *
+ * @return boolean
+ */
+ public function hasIsExtension(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <is_extension> value
+ *
+ * @return \google\protobuf\UninterpretedOption\NamePart
+ */
+ public function clearIsExtension(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <is_extension> value
+ *
+ * @return boolean
+ */
+ public function getIsExtension(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <is_extension> value
+ *
+ * @param boolean $value
+ * @return \google\protobuf\UninterpretedOption\NamePart
+ */
+ public function setIsExtension( $value){
+ return $this->_set(2, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf {
+
+ class SourceCodeInfo extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\SourceCodeInfo");
+
+ // repeated .google.protobuf.SourceCodeInfo.Location location = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "location";
+ $f->nameOrig = "location";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\SourceCodeInfo\Location";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var \google\protobuf\SourceCodeInfo\Location[] */
+ public $location = array();
+
+
+ /**
+ * Check if <location> has a value
+ *
+ * @return boolean
+ */
+ public function hasLocation(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <location> value
+ *
+ * @return \google\protobuf\SourceCodeInfo
+ */
+ public function clearLocation(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <location> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function getLocation($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <location> value
+ *
+ * @param \google\protobuf\SourceCodeInfo\Location $value
+ * @return \google\protobuf\SourceCodeInfo
+ */
+ public function setLocation(\google\protobuf\SourceCodeInfo\Location $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <location>
+ *
+ * @return \google\protobuf\SourceCodeInfo\Location[]
+ */
+ public function getLocationList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <location>
+ *
+ * @param \google\protobuf\SourceCodeInfo\Location $value
+ * @return \google\protobuf\SourceCodeInfo
+ */
+ public function addLocation(\google\protobuf\SourceCodeInfo\Location $value){
+ return $this->_add(1, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\SourceCodeInfo {
+
+ class Location extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\SourceCodeInfo\Location");
+
+ // repeated path = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "path";
+ $f->nameOrig = "path";
+ $f->type = 5;
+ $f->rule = 3;
+ $descriptor->addField($f);
+
+ // repeated span = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "span";
+ $f->nameOrig = "span";
+ $f->type = 5;
+ $f->rule = 3;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var int[] */
+ public $path = array();
+
+ /** @var int[] */
+ public $span = array();
+
+
+ /**
+ * Check if <path> has a value
+ *
+ * @return boolean
+ */
+ public function hasPath(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <path> value
+ *
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function clearPath(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <path> value
+ *
+ * @param int $idx
+ * @return int
+ */
+ public function getPath($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <path> value
+ *
+ * @param int $value
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function setPath( $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <path>
+ *
+ * @return int[]
+ */
+ public function getPathList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <path>
+ *
+ * @param int $value
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function addPath( $value){
+ return $this->_add(1, $value);
+ }
+
+ /**
+ * Check if <span> has a value
+ *
+ * @return boolean
+ */
+ public function hasSpan(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <span> value
+ *
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function clearSpan(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <span> value
+ *
+ * @param int $idx
+ * @return int
+ */
+ public function getSpan($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <span> value
+ *
+ * @param int $value
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function setSpan( $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <span>
+ *
+ * @return int[]
+ */
+ public function getSpanList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <span>
+ *
+ * @param int $value
+ * @return \google\protobuf\SourceCodeInfo\Location
+ */
+ public function addSpan( $value){
+ return $this->_add(2, $value);
+ }
+
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/descriptor.proto
@@ -1,1 +1,535 @@
-
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc. All rights reserved.
+// http://code.google.com/p/protobuf/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+// Author: kenton@google.com (Kenton Varda)
+// Based on original Protocol Buffers design by
+// Sanjay Ghemawat, Jeff Dean, and others.
+//
+// The messages in this file describe the definitions found in .proto files.
+// A valid .proto file can be translated directly to a FileDescriptorProto
+// without any other information (e.g. without reading its imports).
+
+
+
+package google.protobuf;
+
+option java_package = "com.google.protobuf";
+option java_outer_classname = "DescriptorProtos";
+
+// descriptor.proto must be optimized for speed because reflection-based
+// algorithms don't work during bootstrapping.
+option optimize_for = SPEED;
+
+// The protocol compiler can output a FileDescriptorSet containing the .proto
+// files it parses.
+message FileDescriptorSet {
+ repeated FileDescriptorProto file = 1;
+}
+
+// Describes a complete .proto file.
+message FileDescriptorProto {
+ optional string name = 1; // file name, relative to root of source tree
+ optional string package = 2; // e.g. "foo", "foo.bar", etc.
+
+ // Names of files imported by this file.
+ repeated string dependency = 3;
+
+ // All top-level definitions in this file.
+ repeated DescriptorProto message_type = 4;
+ repeated EnumDescriptorProto enum_type = 5;
+ repeated ServiceDescriptorProto service = 6;
+ repeated FieldDescriptorProto extension = 7;
+
+ optional FileOptions options = 8;
+
+ // This field contains optional information about the original source code.
+ // You may safely remove this entire field whithout harming runtime
+ // functionality of the descriptors -- the information is needed only by
+ // development tools.
+ optional SourceCodeInfo source_code_info = 9;
+}
+
+// Describes a message type.
+message DescriptorProto {
+ optional string name = 1;
+
+ repeated FieldDescriptorProto field = 2;
+ repeated FieldDescriptorProto extension = 6;
+
+ repeated DescriptorProto nested_type = 3;
+ repeated EnumDescriptorProto enum_type = 4;
+
+ message ExtensionRange {
+ optional int32 start = 1;
+ optional int32 end = 2;
+ }
+ repeated ExtensionRange extension_range = 5;
+
+ optional MessageOptions options = 7;
+}
+
+// Describes a field within a message.
+message FieldDescriptorProto {
+ enum Type {
+ // 0 is reserved for errors.
+ // Order is weird for historical reasons.
+ TYPE_DOUBLE = 1;
+ TYPE_FLOAT = 2;
+ TYPE_INT64 = 3; // Not ZigZag encoded. Negative numbers
+ // take 10 bytes. Use TYPE_SINT64 if negative
+ // values are likely.
+ TYPE_UINT64 = 4;
+ TYPE_INT32 = 5; // Not ZigZag encoded. Negative numbers
+ // take 10 bytes. Use TYPE_SINT32 if negative
+ // values are likely.
+ TYPE_FIXED64 = 6;
+ TYPE_FIXED32 = 7;
+ TYPE_BOOL = 8;
+ TYPE_STRING = 9;
+ TYPE_GROUP = 10; // Tag-delimited aggregate.
+ TYPE_MESSAGE = 11; // Length-delimited aggregate.
+
+ // New in version 2.
+ TYPE_BYTES = 12;
+ TYPE_UINT32 = 13;
+ TYPE_ENUM = 14;
+ TYPE_SFIXED32 = 15;
+ TYPE_SFIXED64 = 16;
+ TYPE_SINT32 = 17; // Uses ZigZag encoding.
+ TYPE_SINT64 = 18; // Uses ZigZag encoding.
+ };
+
+ enum Label {
+ // 0 is reserved for errors
+ LABEL_OPTIONAL = 1;
+ LABEL_REQUIRED = 2;
+ LABEL_REPEATED = 3;
+ // TODO(sanjay): Should we add LABEL_MAP?
+ };
+
+ optional string name = 1;
+ optional int32 number = 3;
+ optional Label label = 4;
+
+ // If type_name is set, this need not be set. If both this and type_name
+ // are set, this must be either TYPE_ENUM or TYPE_MESSAGE.
+ optional Type type = 5;
+
+ // For message and enum types, this is the name of the type. If the name
+ // starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
+ // rules are used to find the type (i.e. first the nested types within this
+ // message are searched, then within the parent, on up to the root
+ // namespace).
+ optional string type_name = 6;
+
+ // For extensions, this is the name of the type being extended. It is
+ // resolved in the same manner as type_name.
+ optional string extendee = 2;
+
+ // For numeric types, contains the original text representation of the value.
+ // For booleans, "true" or "false".
+ // For strings, contains the default text contents (not escaped in any way).
+ // For bytes, contains the C escaped value. All bytes >= 128 are escaped.
+ // TODO(kenton): Base-64 encode?
+ optional string default_value = 7;
+
+ optional FieldOptions options = 8;
+}
+
+// Describes an enum type.
+message EnumDescriptorProto {
+ optional string name = 1;
+
+ repeated EnumValueDescriptorProto value = 2;
+
+ optional EnumOptions options = 3;
+}
+
+// Describes a value within an enum.
+message EnumValueDescriptorProto {
+ optional string name = 1;
+ optional int32 number = 2;
+
+ optional EnumValueOptions options = 3;
+}
+
+// Describes a service.
+message ServiceDescriptorProto {
+ optional string name = 1;
+ repeated MethodDescriptorProto method = 2;
+
+ optional ServiceOptions options = 3;
+}
+
+// Describes a method of a service.
+message MethodDescriptorProto {
+ optional string name = 1;
+
+ // Input and output type names. These are resolved in the same way as
+ // FieldDescriptorProto.type_name, but must refer to a message type.
+ optional string input_type = 2;
+ optional string output_type = 3;
+
+ optional MethodOptions options = 4;
+}
+
+// ===================================================================
+// Options
+
+// Each of the definitions above may have "options" attached. These are
+// just annotations which may cause code to be generated slightly differently
+// or may contain hints for code that manipulates protocol messages.
+//
+// Clients may define custom options as extensions of the *Options messages.
+// These extensions may not yet be known at parsing time, so the parser cannot
+// store the values in them. Instead it stores them in a field in the *Options
+// message called uninterpreted_option. This field must have the same name
+// across all *Options messages. We then use this field to populate the
+// extensions when we build a descriptor, at which point all protos have been
+// parsed and so all extensions are known.
+//
+// Extension numbers for custom options may be chosen as follows:
+// * For options which will only be used within a single application or
+// organization, or for experimental options, use field numbers 50000
+// through 99999. It is up to you to ensure that you do not use the
+// same number for multiple options.
+// * For options which will be published and used publicly by multiple
+// independent entities, e-mail kenton@google.com to reserve extension
+// numbers. Simply tell me how many you need and I'll send you back a
+// set of numbers to use -- there's no need to explain how you intend to
+// use them. If this turns out to be popular, a web service will be set up
+// to automatically assign option numbers.
+
+
+message FileOptions {
+
+ // Sets the Java package where classes generated from this .proto will be
+ // placed. By default, the proto package is used, but this is often
+ // inappropriate because proto packages do not normally start with backwards
+ // domain names.
+ optional string java_package = 1;
+
+
+ // If set, all the classes from the .proto file are wrapped in a single
+ // outer class with the given name. This applies to both Proto1
+ // (equivalent to the old "--one_java_file" option) and Proto2 (where
+ // a .proto always translates to a single class, but you may want to
+ // explicitly choose the class name).
+ optional string java_outer_classname = 8;
+
+ // If set true, then the Java code generator will generate a separate .java
+ // file for each top-level message, enum, and service defined in the .proto
+ // file. Thus, these types will *not* be nested inside the outer class
+ // named by java_outer_classname. However, the outer class will still be
+ // generated to contain the file's getDescriptor() method as well as any
+ // top-level extensions defined in the file.
+ optional bool java_multiple_files = 10 [default=false];
+
+ // If set true, then the Java code generator will generate equals() and
+ // hashCode() methods for all messages defined in the .proto file. This is
+ // purely a speed optimization, as the AbstractMessage base class includes
+ // reflection-based implementations of these methods.
+ optional bool java_generate_equals_and_hash = 20 [default=false];
+
+ // Generated classes can be optimized for speed or code size.
+ enum OptimizeMode {
+ SPEED = 1; // Generate complete code for parsing, serialization,
+ // etc.
+ CODE_SIZE = 2; // Use ReflectionOps to implement these methods.
+ LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime.
+ }
+ optional OptimizeMode optimize_for = 9 [default=SPEED];
+
+
+
+
+ // Should generic services be generated in each language? "Generic" services
+ // are not specific to any particular RPC system. They are generated by the
+ // main code generators in each language (without additional plugins).
+ // Generic services were the only kind of service generation supported by
+ // early versions of proto2.
+ //
+ // Generic services are now considered deprecated in favor of using plugins
+ // that generate code specific to your particular RPC system. Therefore,
+ // these default to false. Old code which depends on generic services should
+ // explicitly set them to true.
+ optional bool cc_generic_services = 16 [default=false];
+ optional bool java_generic_services = 17 [default=false];
+ optional bool py_generic_services = 18 [default=false];
+
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+message MessageOptions {
+ // Set true to use the old proto1 MessageSet wire format for extensions.
+ // This is provided for backwards-compatibility with the MessageSet wire
+ // format. You should not use this for any other reason: It's less
+ // efficient, has fewer features, and is more complicated.
+ //
+ // The message must be defined exactly as follows:
+ // message Foo {
+ // option message_set_wire_format = true;
+ // extensions 4 to max;
+ // }
+ // Note that the message cannot have any defined fields; MessageSets only
+ // have extensions.
+ //
+ // All extensions of your type must be singular messages; e.g. they cannot
+ // be int32s, enums, or repeated messages.
+ //
+ // Because this is an option, the above two restrictions are not enforced by
+ // the protocol compiler.
+ optional bool message_set_wire_format = 1 [default=false];
+
+ // Disables the generation of the standard "descriptor()" accessor, which can
+ // conflict with a field of the same name. This is meant to make migration
+ // from proto1 easier; new code should avoid fields named "descriptor".
+ optional bool no_standard_descriptor_accessor = 2 [default=false];
+
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+message FieldOptions {
+ // The ctype option instructs the C++ code generator to use a different
+ // representation of the field than it normally would. See the specific
+ // options below. This option is not yet implemented in the open source
+ // release -- sorry, we'll try to include it in a future version!
+ optional CType ctype = 1 [default = STRING];
+ enum CType {
+ // Default mode.
+ STRING = 0;
+
+ CORD = 1;
+
+ STRING_PIECE = 2;
+ }
+ // The packed option can be enabled for repeated primitive fields to enable
+ // a more efficient representation on the wire. Rather than repeatedly
+ // writing the tag and type for each element, the entire array is encoded as
+ // a single length-delimited blob.
+ optional bool packed = 2;
+
+
+ // Is this field deprecated?
+ // Depending on the target platform, this can emit Deprecated annotations
+ // for accessors, or it will be completely ignored; in the very least, this
+ // is a formalization for deprecating fields.
+ optional bool deprecated = 3 [default=false];
+
+ // EXPERIMENTAL. DO NOT USE.
+ // For "map" fields, the name of the field in the enclosed type that
+ // is the key for this map. For example, suppose we have:
+ // message Item {
+ // required string name = 1;
+ // required string value = 2;
+ // }
+ // message Config {
+ // repeated Item items = 1 [experimental_map_key="name"];
+ // }
+ // In this situation, the map key for Item will be set to "name".
+ // TODO: Fully-implement this, then remove the "experimental_" prefix.
+ optional string experimental_map_key = 9;
+
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+message EnumOptions {
+
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+message EnumValueOptions {
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+message ServiceOptions {
+
+ // Note: Field numbers 1 through 32 are reserved for Google's internal RPC
+ // framework. We apologize for hoarding these numbers to ourselves, but
+ // we were already using them long before we decided to release Protocol
+ // Buffers.
+
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+message MethodOptions {
+
+ // Note: Field numbers 1 through 32 are reserved for Google's internal RPC
+ // framework. We apologize for hoarding these numbers to ourselves, but
+ // we were already using them long before we decided to release Protocol
+ // Buffers.
+
+ // The parser stores options it doesn't recognize here. See above.
+ repeated UninterpretedOption uninterpreted_option = 999;
+
+ // Clients can define custom options in extensions of this message. See above.
+ extensions 1000 to max;
+}
+
+// A message representing a option the parser does not recognize. This only
+// appears in options protos created by the compiler::Parser class.
+// DescriptorPool resolves these when building Descriptor objects. Therefore,
+// options protos in descriptor objects (e.g. returned by Descriptor::options(),
+// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
+// in them.
+message UninterpretedOption {
+ // The name of the uninterpreted option. Each string represents a segment in
+ // a dot-separated name. is_extension is true iff a segment represents an
+ // extension (denoted with parentheses in options specs in .proto files).
+ // E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
+ // "foo.(bar.baz).qux".
+ message NamePart {
+ required string name_part = 1;
+ required bool is_extension = 2;
+ }
+ repeated NamePart name = 2;
+
+ // The value of the uninterpreted option, in whatever type the tokenizer
+ // identified it as during parsing. Exactly one of these should be set.
+ optional string identifier_value = 3;
+ optional uint64 positive_int_value = 4;
+ optional int64 negative_int_value = 5;
+ optional double double_value = 6;
+ optional bytes string_value = 7;
+ optional string aggregate_value = 8;
+}
+
+// ===================================================================
+// Optional source code info
+
+// Encapsulates information about the original source file from which a
+// FileDescriptorProto was generated.
+message SourceCodeInfo {
+ // A Location identifies a piece of source code in a .proto file which
+ // corresponds to a particular definition. This information is intended
+ // to be useful to IDEs, code indexers, documentation generators, and similar
+ // tools.
+ //
+ // For example, say we have a file like:
+ // message Foo {
+ // optional string foo = 1;
+ // }
+ // Let's look at just the field definition:
+ // optional string foo = 1;
+ // ^ ^^ ^^ ^ ^^^
+ // a bc de f ghi
+ // We have the following locations:
+ // span path represents
+ // [a,i) [ 4, 0, 2, 0 ] The whole field definition.
+ // [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
+ // [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
+ // [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
+ // [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
+ //
+ // Notes:
+ // - A location may refer to a repeated field itself (i.e. not to any
+ // particular index within it). This is used whenever a set of elements are
+ // logically enclosed in a single code segment. For example, an entire
+ // extend block (possibly containing multiple extension definitions) will
+ // have an outer location whose path refers to the "extensions" repeated
+ // field without an index.
+ // - Multiple locations may have the same path. This happens when a single
+ // logical declaration is spread out across multiple places. The most
+ // obvious example is the "extend" block again -- there may be multiple
+ // extend blocks in the same scope, each of which will have the same path.
+ // - A location's span is not always a subset of its parent's span. For
+ // example, the "extendee" of an extension declaration appears at the
+ // beginning of the "extend" block and is shared by all extensions within
+ // the block.
+ // - Just because a location's span is a subset of some other location's span
+ // does not mean that it is a descendent. For example, a "group" defines
+ // both a type and a field in a single declaration. Thus, the locations
+ // corresponding to the type and field and their components will overlap.
+ // - Code which tries to interpret locations should probably be designed to
+ // ignore those that it doesn't understand, as more types of locations could
+ // be recorded in the future.
+ repeated Location location = 1;
+ message Location {
+ // Identifies which part of the FileDescriptorProto was defined at this
+ // location.
+ //
+ // Each element is a field number or an index. They form a path from
+ // the root FileDescriptorProto to the place where the definition. For
+ // example, this path:
+ // [ 4, 3, 2, 7, 1 ]
+ // refers to:
+ // file.message_type(3) // 4, 3
+ // .field(7) // 2, 7
+ // .name() // 1
+ // This is because FileDescriptorProto.message_type has field number 4:
+ // repeated DescriptorProto message_type = 4;
+ // and DescriptorProto.field has field number 2:
+ // repeated FieldDescriptorProto field = 2;
+ // and FieldDescriptorProto.name has field number 1:
+ // optional string name = 1;
+ //
+ // Thus, the above path gives the location of a field name. If we removed
+ // the last element:
+ // [ 4, 3, 2, 7 ]
+ // this path refers to the whole field declaration (from the beginning
+ // of the label to the terminating semicolon).
+ repeated int32 path = 1 [packed=true];
+
+ // Always has exactly three or four elements: start line, start column,
+ // end line (optional, otherwise assumed same as start line), end column.
+ // These are packed into a single field for efficiency. Note that line
+ // and column numbers are zero-based -- typically you will want to add
+ // 1 to each before displaying to a user.
+ repeated int32 span = 2 [packed=true];
+
+ // TODO(kenton): Record comments appearing before and after the
+ // declaration.
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/json.pb.php
@@ -1,1 +1,28 @@
+<?php
+// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin @package_version@
+// Source: php.proto
+// Date: 2011-03-20 01:27:38
+namespace {
+
+ \google\protobuf\FileOptions::extension(function(){
+ // optional php.namespace = 50002
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 50102;
+ $f->name = "json.namespace";
+ $f->type = 9;
+ $f->rule = 1;
+ return $f;
+ });
+ \google\protobuf\FileOptions::extension(function(){
+ // optional php.suffix = 50003
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 50103;
+ $f->name = "json.suffix";
+ $f->type = 9;
+ $f->rule = 1;
+ $f->default = ".pb.js";
+ return $f;
+ });
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/json.proto
@@ -1,1 +1,37 @@
+import "descriptor.proto";
+package json;
+
+extend google.protobuf.FileOptions {
+
+ // Set the namespace (overrides package)
+ optional string namespace = 50102;
+ // Suffix for file names
+ optional string suffix = 50103 [default = ".pb.js"];
+
+}
+
+//extend google.protobuf.MessageOptions {
+//
+//}
+//
+//extend google.protobuf.FieldOptions {
+//
+//}
+//
+//extend google.protobuf.EnumOptions {
+//
+//}
+//
+//extend google.protobuf.EnumValueOptions {
+//
+//}
+//
+//extend google.protobuf.ServiceOptions {
+//
+//}
+//
+//extend google.protobuf.MethodOptions {
+//
+//}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/php.pb.php
@@ -1,1 +1,48 @@
+<?php
+// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin @package_version@
+// Source: php.proto
+// Date: 2011-03-20 01:27:38
+namespace {
+
+ \google\protobuf\FileOptions::extension(function(){
+ // optional php.namespace = 50002
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 50002;
+ $f->name = "php.namespace";
+ $f->type = 9;
+ $f->rule = 1;
+ return $f;
+ });
+ \google\protobuf\FileOptions::extension(function(){
+ // optional php.suffix = 50003
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 50003;
+ $f->name = "php.suffix";
+ $f->type = 9;
+ $f->rule = 1;
+ $f->default = ".php";
+ return $f;
+ });
+ \google\protobuf\FileOptions::extension(function(){
+ // optional php.multiple = 50004
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 50004;
+ $f->name = "php.multifile";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = false;
+ return $f;
+ });
+ \google\protobuf\FileOptions::extension(function(){
+ // optional php.generic_services = 50005
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 50005;
+ $f->name = "php.generic_services";
+ $f->type = 8;
+ $f->rule = 1;
+ $f->default = false;
+ return $f;
+ });
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/php.proto
@@ -1,1 +1,41 @@
+import "descriptor.proto";
+package php;
+
+extend google.protobuf.FileOptions {
+
+ // Set the namespace (overrides package)
+ optional string namespace = 50002;
+ // Suffix for file names
+ optional string suffix = 50003 [default = ".php"];
+ // Generate a file for each structure in the proto
+ optional bool multifile = 50004 [default = false];
+ // Generate interfaces for service definitions
+ optional bool generic_services = 50005 [default = false];
+
+}
+
+//extend google.protobuf.MessageOptions {
+//
+//}
+//
+//extend google.protobuf.FieldOptions {
+//
+//}
+//
+//extend google.protobuf.EnumOptions {
+//
+//}
+//
+//extend google.protobuf.EnumValueOptions {
+//
+//}
+//
+//extend google.protobuf.ServiceOptions {
+//
+//}
+//
+//extend google.protobuf.MethodOptions {
+//
+//}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/plugin.pb.php
@@ -1,1 +1,555 @@
-
+<?php
+// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin @package_version@
+// Source: plugin.proto
+// Date: 2011-03-20 01:27:33
+
+namespace google\protobuf\compiler {
+
+ class CodeGeneratorRequest extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\compiler\CodeGeneratorRequest");
+
+ // repeated file_to_generate = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "file_to_generate";
+ $f->type = 9;
+ $f->rule = 3;
+ $descriptor->addField($f);
+
+ // optional parameter = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "parameter";
+ $f->nameOrig = "parameter";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.FileDescriptorProto proto_file = 15
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 15;
+ $f->name = "proto_file";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\FileDescriptorProto";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string[] */
+ public $file_to_generate = array();
+
+ /** @var string */
+ public $parameter = null;
+
+ /** @var \google\protobuf\FileDescriptorProto[] */
+ public $proto_file = array();
+
+
+ /**
+ * Check if <file_to_generate> has a value
+ *
+ * @return boolean
+ */
+ public function hasFileToGenerate(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <file_to_generate> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function clearFileToGenerate(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <file_to_generate> value
+ *
+ * @param int $idx
+ * @return string
+ */
+ public function getFileToGenerate($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <file_to_generate> value
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function setFileToGenerate( $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <file_to_generate>
+ *
+ * @return string[]
+ */
+ public function getFileToGenerateList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <file_to_generate>
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function addFileToGenerate( $value){
+ return $this->_add(1, $value);
+ }
+
+ /**
+ * Check if <parameter> has a value
+ *
+ * @return boolean
+ */
+ public function hasParameter(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <parameter> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function clearParameter(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <parameter> value
+ *
+ * @return string
+ */
+ public function getParameter(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <parameter> value
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function setParameter( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <proto_file> has a value
+ *
+ * @return boolean
+ */
+ public function hasProtoFile(){
+ return $this->_has(15);
+ }
+
+ /**
+ * Clear <proto_file> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function clearProtoFile(){
+ return $this->_clear(15);
+ }
+
+ /**
+ * Get <proto_file> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\FileDescriptorProto
+ */
+ public function getProtoFile($idx = NULL){
+ return $this->_get(15, $idx);
+ }
+
+ /**
+ * Set <proto_file> value
+ *
+ * @param \google\protobuf\FileDescriptorProto $value
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function setProtoFile(\google\protobuf\FileDescriptorProto $value, $idx = NULL){
+ return $this->_set(15, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <proto_file>
+ *
+ * @return \google\protobuf\FileDescriptorProto[]
+ */
+ public function getProtoFileList(){
+ return $this->_get(15);
+ }
+
+ /**
+ * Add a new element to <proto_file>
+ *
+ * @param \google\protobuf\FileDescriptorProto $value
+ * @return \google\protobuf\compiler\CodeGeneratorRequest
+ */
+ public function addProtoFile(\google\protobuf\FileDescriptorProto $value){
+ return $this->_add(15, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\compiler {
+
+ class CodeGeneratorResponse extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\compiler\CodeGeneratorResponse");
+
+ // optional error = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "error";
+ $f->nameOrig = "error";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .google.protobuf.compiler.CodeGeneratorResponse.File file = 15
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 15;
+ $f->name = "file";
+ $f->nameOrig = "file";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = "\google\protobuf\compiler\CodeGeneratorResponse\File";
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $error = null;
+
+ /** @var \google\protobuf\compiler\CodeGeneratorResponse\File[] */
+ public $file = array();
+
+
+ /**
+ * Check if <error> has a value
+ *
+ * @return boolean
+ */
+ public function hasError(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <error> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorResponse
+ */
+ public function clearError(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <error> value
+ *
+ * @return string
+ */
+ public function getError(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <error> value
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorResponse
+ */
+ public function setError( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <file> has a value
+ *
+ * @return boolean
+ */
+ public function hasFile(){
+ return $this->_has(15);
+ }
+
+ /**
+ * Clear <file> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorResponse
+ */
+ public function clearFile(){
+ return $this->_clear(15);
+ }
+
+ /**
+ * Get <file> value
+ *
+ * @param int $idx
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function getFile($idx = NULL){
+ return $this->_get(15, $idx);
+ }
+
+ /**
+ * Set <file> value
+ *
+ * @param \google\protobuf\compiler\CodeGeneratorResponse\File $value
+ * @return \google\protobuf\compiler\CodeGeneratorResponse
+ */
+ public function setFile(\google\protobuf\compiler\CodeGeneratorResponse\File $value, $idx = NULL){
+ return $this->_set(15, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <file>
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File[]
+ */
+ public function getFileList(){
+ return $this->_get(15);
+ }
+
+ /**
+ * Add a new element to <file>
+ *
+ * @param \google\protobuf\compiler\CodeGeneratorResponse\File $value
+ * @return \google\protobuf\compiler\CodeGeneratorResponse
+ */
+ public function addFile(\google\protobuf\compiler\CodeGeneratorResponse\File $value){
+ return $this->_add(15, $value);
+ }
+
+ }
+}
+
+namespace google\protobuf\compiler\CodeGeneratorResponse {
+
+ class File extends \DrSlump\Protobuf\Message {
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected static $__descriptor;
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ if (NULL !== $descriptor) {
+ self::$__descriptor = $descriptor;
+ return self::$__descriptor;
+ }
+
+ if (!self::$__descriptor) {
+ $descriptor = new \DrSlump\Protobuf\Descriptor("\google\protobuf\compiler\CodeGeneratorResponse\File");
+
+ // optional name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->nameOrig = "name";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional insertion_point = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "insertion_point";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // optional content = 15
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 15;
+ $f->name = "content";
+ $f->nameOrig = "content";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ self::$__descriptor = $descriptor;
+ }
+
+ return self::$__descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var string */
+ public $insertion_point = null;
+
+ /** @var string */
+ public $content = null;
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <insertion_point> has a value
+ *
+ * @return boolean
+ */
+ public function hasInsertionPoint(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <insertion_point> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function clearInsertionPoint(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <insertion_point> value
+ *
+ * @return string
+ */
+ public function getInsertionPoint(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <insertion_point> value
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function setInsertionPoint( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <content> has a value
+ *
+ * @return boolean
+ */
+ public function hasContent(){
+ return $this->_has(15);
+ }
+
+ /**
+ * Clear <content> value
+ *
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function clearContent(){
+ return $this->_clear(15);
+ }
+
+ /**
+ * Get <content> value
+ *
+ * @return string
+ */
+ public function getContent(){
+ return $this->_get(15);
+ }
+
+ /**
+ * Set <content> value
+ *
+ * @param string $value
+ * @return \google\protobuf\compiler\CodeGeneratorResponse\File
+ */
+ public function setContent( $value){
+ return $this->_set(15, $value);
+ }
+
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos/plugin.proto
@@ -1,1 +1,146 @@
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc. All rights reserved.
+// http://code.google.com/p/protobuf/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+// Author: kenton@google.com (Kenton Varda)
+//
+// WARNING: The plugin interface is currently EXPERIMENTAL and is subject to
+// change.
+//
+// protoc (aka the Protocol Compiler) can be extended via plugins. A plugin is
+// just a program that reads a CodeGeneratorRequest from stdin and writes a
+// CodeGeneratorResponse to stdout.
+//
+// Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
+// of dealing with the raw protocol defined here.
+//
+// A plugin executable needs only to be placed somewhere in the path. The
+// plugin should be named "protoc-gen-$NAME", and will then be used when the
+// flag "--${NAME}_out" is passed to protoc.
+
+package google.protobuf.compiler;
+
+import "descriptor.proto";
+
+// An encoded CodeGeneratorRequest is written to the plugin's stdin.
+message CodeGeneratorRequest {
+ // The .proto files that were explicitly listed on the command-line. The
+ // code generator should generate code only for these files. Each file's
+ // descriptor will be included in proto_file, below.
+ repeated string file_to_generate = 1;
+
+ // The generator parameter passed on the command-line.
+ optional string parameter = 2;
+
+ // FileDescriptorProtos for all files in files_to_generate and everything
+ // they import. The files will appear in topological order, so each file
+ // appears before any file that imports it.
+ //
+ // protoc guarantees that all proto_files will be written after
+ // the fields above, even though this is not technically guaranteed by the
+ // protobuf wire format. This theoretically could allow a plugin to stream
+ // in the FileDescriptorProtos and handle them one by one rather than read
+ // the entire set into memory at once. However, as of this writing, this
+ // is not similarly optimized on protoc's end -- it will store all fields in
+ // memory at once before sending them to the plugin.
+ repeated FileDescriptorProto proto_file = 15;
+}
+
+// The plugin writes an encoded CodeGeneratorResponse to stdout.
+message CodeGeneratorResponse {
+ // Error message. If non-empty, code generation failed. The plugin process
+ // should exit with status code zero even if it reports an error in this way.
+ //
+ // This should be used to indicate errors in .proto files which prevent the
+ // code generator from generating correct code. Errors which indicate a
+ // problem in protoc itself -- such as the input CodeGeneratorRequest being
+ // unparseable -- should be reported by writing a message to stderr and
+ // exiting with a non-zero status code.
+ optional string error = 1;
+
+ // Represents a single generated file.
+ message File {
+ // The file name, relative to the output directory. The name must not
+ // contain "." or ".." components and must be relative, not be absolute (so,
+ // the file cannot lie outside the output directory). "/" must be used as
+ // the path separator, not "\".
+ //
+ // If the name is omitted, the content will be appended to the previous
+ // file. This allows the generator to break large files into small chunks,
+ // and allows the generated text to be streamed back to protoc so that large
+ // files need not reside completely in memory at one time. Note that as of
+ // this writing protoc does not optimize for this -- it will read the entire
+ // CodeGeneratorResponse before writing files to disk.
+ optional string name = 1;
+
+ // If non-empty, indicates that the named file should already exist, and the
+ // content here is to be inserted into that file at a defined insertion
+ // point. This feature allows a code generator to extend the output
+ // produced by another code generator. The original generator may provide
+ // insertion points by placing special annotations in the file that look
+ // like:
+ // @@protoc_insertion_point(NAME)
+ // The annotation can have arbitrary text before and after it on the line,
+ // which allows it to be placed in a comment. NAME should be replaced with
+ // an identifier naming the point -- this is what other generators will use
+ // as the insertion_point. Code inserted at this point will be placed
+ // immediately above the line containing the insertion point (thus multiple
+ // insertions to the same point will come out in the order they were added).
+ // The double-@ is intended to make it unlikely that the generated code
+ // could contain things that look like insertion points by accident.
+ //
+ // For example, the C++ code generator places the following line in the
+ // .pb.h files that it generates:
+ // // @@protoc_insertion_point(namespace_scope)
+ // This line appears within the scope of the file's package namespace, but
+ // outside of any particular class. Another plugin can then specify the
+ // insertion_point "namespace_scope" to generate additional classes or
+ // other declarations that should be placed in this scope.
+ //
+ // Note that if the line containing the insertion point begins with
+ // whitespace, the same whitespace will be added to every line of the
+ // inserted text. This is useful for languages like Python, where
+ // indentation matters. In these languages, the insertion point comment
+ // should be indented the same amount as any inserted code will need to be
+ // in order to work correctly in that context.
+ //
+ // The code generator that generates the initial file and the one which
+ // inserts into it must both run as part of a single invocation of protoc.
+ // Code generators are executed in the order in which they appear on the
+ // command line.
+ //
+ // If |insertion_point| is present, |name| must also be present.
+ optional string insertion_point = 2;
+
+ // The file contents.
+ optional string content = 15;
+ }
+ repeated File file = 15;
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Descriptor.php
@@ -1,1 +1,121 @@
+<?php
+namespace DrSlump\Protobuf;
+
+use DrSlump\Protobuf;
+
+class Descriptor
+{
+ /** @var String Holds the class name of the message */
+ protected $class;
+
+ /** @var String Holds the original proto name */
+ protected $name;
+
+ /** @var \DrSlump\Protobuf\Field[] */
+ protected $fields = array();
+
+ /** @var array - Cache the relation between names and tags */
+ protected $names = array();
+
+
+ /**
+ * @param string $class
+ * @param string $name
+ */
+ public function __construct($class, $name = null)
+ {
+ $this->class = trim($class, '\\ ');
+ $this->name = $name ? trim($name, '. ') : NULL;
+ }
+
+ /**
+ * @return string
+ */
+ public function getClass()
+ {
+ return $this->class;
+ }
+
+ /**
+ * @return string|null
+ */
+ public function getName()
+ {
+ return $this->name;
+ }
+
+ /**
+ * Obtain the list of fields in the message
+ *
+ * @return \DrSlump\Protobuf\Field[]
+ */
+ public function getFields()
+ {
+ return $this->fields;
+ }
+
+ /**
+ * Adds a field to the message
+ *
+ * @param \DrSlump\Protobuf\Field $field
+ * @param bool $isExtension
+ */
+ public function addField(Protobuf\Field $field, $isExtension = false)
+ {
+ $field->extension = $isExtension;
+ $this->fields[ $field->number ] = $field;
+ }
+
+ /**
+ * Obtain a field descriptor by its tag number
+ *
+ * @param int $tag
+ * @return \DrSlump\Protobuf\Field | NULL
+ */
+ public function getField($tag)
+ {
+ return isset($this->fields[$tag])
+ ? $this->fields[$tag]
+ : NULL;
+ }
+
+ /**
+ * Obtain a field descriptor by its name
+ *
+ * @param string $name
+ * @return \DrSlump\Protobuf\Field | NULL
+ */
+ public function getFieldByName($name)
+ {
+ // Check cached map
+ if (isset($this->names[$name])) {
+ return $this->getField($this->names[$name]);
+ }
+
+ // Loop thru all fields to find it
+ foreach ($this->fields as $tag=>$field) {
+ // Cache it for next calls
+ $fname = $field->getName();
+ $this->names[$fname] = $tag;
+
+ if ($name === $fname) {
+ return $field;
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Check if the given tag number matches a field
+ *
+ * @param int $tag
+ * @return bool
+ */
+ public function hasField($tag)
+ {
+ return isset($this->fields[$tag]);
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Exception.php
@@ -1,1 +1,8 @@
+<?php
+namespace DrSlump\Protobuf;
+
+class Exception extends \Exception
+{
+
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Field.php
@@ -1,1 +1,86 @@
+<?php
+namespace DrSlump\Protobuf;
+
+use DrSlump\Protobuf;
+
+class Field
+{
+ public $number;
+ public $name;
+ public $type = Protobuf::TYPE_UNKNOWN;
+ public $rule = Protobuf::RULE_OPTIONAL;
+ public $reference;
+ public $default;
+ public $packed = false;
+ public $extension = false;
+
+ public function __construct(array $opts = array())
+ {
+ if (!empty($opts)) {
+ if (isset($opts['number'])) $this->number = (int)$opts['number'];
+ if (isset($opts['name'])) $this->name = $opts['name'];
+ if (isset($opts['type'])) $this->type = (int)$opts['type'];
+ if (isset($opts['rule'])) $this->rule = (int)$opts['rule'];
+ if (isset($opts['packed'])) $this->packed = (bool)$opts['packed'];
+ if (isset($opts['reference'])) $this->reference = $opts['reference'];
+ if (isset($opts['default'])) $this->default = $opts['default'];
+ if (isset($opts['extension'])) $this->extension = (bool)$opts['extension'];
+ }
+ }
+
+ public function getNumber()
+ {
+ return $this->number;
+ }
+
+ public function getType()
+ {
+ return $this->type;
+ }
+
+ public function getName()
+ {
+ return $this->name;
+ }
+
+ public function getReference()
+ {
+ return $this->reference;
+ }
+
+ public function getDefault()
+ {
+ return $this->default;
+ }
+
+ public function hasDefault()
+ {
+ return $this->default !== NULL;
+ }
+
+ public function isOptional()
+ {
+ return $this->rule === Protobuf::RULE_OPTIONAL;
+ }
+
+ public function isRequired()
+ {
+ return $this->rule === Protobuf::RULE_REQUIRED;
+ }
+
+ public function isRepeated()
+ {
+ return $this->rule === Protobuf::RULE_REPEATED;
+ }
+
+ public function isPacked()
+ {
+ return $this->packed;
+ }
+
+ public function isExtension()
+ {
+ return $this->extension;
+ }
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Message.php
@@ -1,1 +1,377 @@
-
+<?php
+
+namespace DrSlump\Protobuf;
+
+use DrSlump\Protobuf;
+
+abstract class Message implements \ArrayAccess
+{
+ /** @var \Closure[] */
+ static protected $__extensions = array();
+
+ /** @var \DrSlump\Protobuf\Descriptor */
+ protected $_descriptor;
+ /** @var array Store data for extension fields */
+ protected $_extensions = array();
+ /** @var array Store data for unknown values */
+ protected $_unknown = array();
+
+ /**
+ * @static
+ * @abstract
+ * @return \DrSlump\Protobuf\Descriptor
+ */
+ public static function descriptor()
+ {
+ throw new \BadMethodCallException('This method should be implemented in inherited classes');
+ }
+
+ /**
+ * Register an extension configuration callback
+ *
+ * @static
+ * @param \Closure $fn
+ */
+ public static function extension(\Closure $fn)
+ {
+ static::$__extensions[] = $fn;
+ }
+
+ /**
+ * @param string $data
+ */
+ public function __construct($data = null)
+ {
+ // Cache the descriptor instance
+ $this->_descriptor = Protobuf::getRegistry()->getDescriptor($this);
+
+ // Assign default values to extensions
+ foreach ($this->_descriptor->getFields() as $f) {
+ if ($f->isExtension() && $f->hasDefault()) {
+ $this->_extensions[$f->getName()] = $f->getDefault();
+ }
+ }
+
+ if (NULL !== $data) {
+ $this->parse($data);
+ }
+ }
+
+ // Implements ArrayAccess for extensions and unknown fields
+
+ public function offsetExists($offset)
+ {
+ if (is_numeric($offset)) {
+ return $this->_has($offset);
+ } else {
+ return $this->hasExtension($offset);
+ }
+ }
+
+ public function offsetSet($offset, $value)
+ {
+ if (is_numeric($offset)) {
+ $this->_set($offset, $value);
+ } else {
+ $this->setExtension($offset, $value);
+ }
+ }
+
+ public function offsetGet( $offset )
+ {
+ if (is_numeric($offset)) {
+ return $this->_get($offset);
+ } else {
+ return $this->getExtension($offset);
+ }
+ }
+
+ public function offsetUnset( $offset )
+ {
+ if (is_numeric($offset)) {
+ $this->_clear($offset);
+ } else {
+ $this->clearExtension($offset);
+ }
+ }
+
+ /**
+ * Parse the given data to hydrate the object
+ *
+ * @param string $data
+ * @param CodecInterface|null $codec
+ */
+ public function parse($data, Protobuf\CodecInterface $codec = null)
+ {
+ $codec = Protobuf::getCodec($codec);
+ $codec->decode($this, $data);
+ }
+
+ /**
+ * Serialize the current object data
+ *
+ * @param CodecInterface|null $codec
+ * @return string
+ */
+ public function serialize(Protobuf\CodecInterface $codec = null)
+ {
+ $codec = Protobuf::getCodec($codec);
+ return $codec->encode($this);
+ }
+
+
+ /**
+ * Checks if the given tag number is set
+ *
+ * @param int $tag
+ * @return bool
+ */
+ public function _has($tag)
+ {
+ if ($this->_descriptor->hasField($tag)) {
+ $f = $this->_descriptor->getField($tag);
+ $name = $f->getName();
+
+ if ($f->isExtension()) {
+ return $f->isRepeated()
+ ? count($this->_extensions[$name]) > 0
+ : $this->_extensions[$name] !== NULL;
+ } else {
+ return $f->isRepeated()
+ ? count($this->$name) > 0
+ : $this->$name !== NULL;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Get the value by tag number
+ *
+ * @param int $tag
+ * @param int|null $idx
+ * @return mixed
+ */
+ public function _get($tag, $idx = null)
+ {
+ $f = $this->_descriptor->getField($tag);
+
+ if (!$f) {
+ return null;
+ }
+
+ $name = $f->getName();
+
+ if (!$f->isExtension()) {
+
+ return $idx !== NULL
+ ? $this->{$name}[$idx]
+ : $this->$name;
+
+ } else {
+
+ return $idx !== NULL
+ ? $this->_extensions[$name][$idx]
+ : $this->_extensions[$name];
+
+ }
+
+ }
+
+ /**
+ * Sets the value by tag number
+ *
+ * @throws \Exception If trying to set an unknown field
+ * @param int $tag
+ * @param mixed $value
+ * @param int|null $idx
+ * @return \DrSlump\Protobuf\Message - Fluent interface
+ */
+ public function _set($tag, $value, $idx = null)
+ {
+ $f = $this->_descriptor->getField($tag);
+
+ if (!$f) {
+ throw new \Exception('Unknown fields not supported');
+ }
+
+ $name = $f->getName();
+ if (!$f->isExtension()) {
+
+ if ($idx === NULL) {
+ $this->$name = $value;
+ } else {
+ $this->{$name}[$idx] = $value;
+ }
+
+ } else {
+ if ($idx === NULL) {
+ $this->_extensions[$name] = $value;
+ } else {
+ $this->_extensions[$name][$idx] = $value;
+ }
+ }
+
+ return $this;
+ }
+
+ /**
+ * Adds a new value to a repeated field by tag number
+ *
+ * @throws \Exception If trying to modify an unknown field
+ * @param int $tag
+ * @param mixed $value
+ * @return Message
+ */
+ public function _add($tag, $value)
+ {
+ $f = $this->_descriptor->getField($tag);
+
+ if (!$f) {
+ throw new \Exception('Unknown fields not supported');
+ }
+
+ $name = $f->getName();
+ if (!$f->isExtension()) {
+ $this->{$name}[] = $value;
+ } else {
+ $this->_extensions[$name][] = $value;
+ }
+
+ return $this;
+ }
+
+ /**
+ * Clears/Resets a field by tag number
+ *
+ * @throws \Exception If trying to modify an unknown field
+ * @param int $tag
+ * @return \DrSlump\Protobuf\Message - Fluent interface
+ */
+ public function _clear($tag)
+ {
+ $f = $this->_descriptor->getField($tag);
+
+ if (!$f) {
+ throw new \Exception('Unknown fields not supported');
+ }
+
+ $name = $f->getName();
+ if (!$f->isExtension()) {
+ $this->$name = $f->isRepeated()
+ ? array()
+ : NULL;
+ } else {
+ $this->_extensions[$name] = $f->isRepeated()
+ ? array()
+ : NULL;
+ }
+
+ return $this;
+ }
+
+ // Extensions public methods.
+ // @todo Check if extension name is defined
+
+ /**
+ * Checks if an extension field is set
+ *
+ * @param string $extname
+ * @return bool
+ */
+ public function hasExtension($extname)
+ {
+ return isset($this->_extensions[$extname]);
+ }
+
+ /**
+ * Get the value of an extension field
+ *
+ * @param string $extname
+ * @param int|null $idx
+ * @return mixed
+ */
+ public function getExtension($extname, $idx = null)
+ {
+ if (!isset($this->_extensions[$extname])) return NULL;
+
+ return $idx === NULL
+ ? $this->_extensions[$extname]
+ : $this->_extensions[$extname][$idx];
+ }
+
+ /**
+ * Get all the values of a repeated extension field
+ *
+ * @param string $extname
+ * @return array
+ */
+ public function getExtensionList($extname)
+ {
+ return isset($this->_extensions[$extname])
+ ? $this->_extensions[$extname]
+ : array();
+ }
+
+ /**
+ * Set the value for an extension field
+ *
+ * @param string $extname
+ * @param mixed $value
+ * @param int|null $idx
+ * @return \DrSlump\Protobuf\Message - Fluent Interface
+ */
+ public function setExtension($extname, $value, $idx = null)
+ {
+ if (NULL !== $idx) {
+ if (empty($this->_extensions)) {
+ $this->_extensions[$extname] = array();
+ }
+ $this->_extensions[$extname][$idx] = $value;
+ }
+
+ $this->_extensions[$extname] = $value;
+
+ return $this;
+ }
+
+ /**
+ * Adds a value to repeated extension field
+ *
+ * @param string $extname
+ * @param mixed $value
+ * @return \DrSlump\Protobuf\Message - Fluent Interface
+ */
+ public function addExtension($extname, $value)
+ {
+ $this->_extensions[$extname][] = $value;
+ }
+
+ /**
+ * @param $extname
+ * @return void
+ */
+ public function clearExtension($extname)
+ {
+ unset($this->_extensions[$extname]);
+ }
+
+
+ public function addUnknown(Unknown $unknown)
+ {
+ $this->_unknown[] = $unknown;
+ }
+
+ public function getUnknown()
+ {
+ return $this->_unknown;
+ }
+
+ public function clearUnknown()
+ {
+ $this->_unknown = array();
+ }
+
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Registry.php
@@ -1,1 +1,75 @@
+<?php
+namespace DrSlump\Protobuf;
+
+use DrSlump\Protobuf;
+
+/**
+ * Keeps instances of the different message descriptors used.
+ *
+ */
+class Registry
+{
+ /** @var array */
+ protected $descriptors = array();
+
+ /**
+ * @param string|\DrSlump\Protobuf\Message $message
+ * @param \DrSlump\Protobuf\Descriptor $descriptor
+ */
+ public function setDescriptor($message, Descriptor $descriptor)
+ {
+ $message = is_object($message) ? get_class($message) : $message;
+ $message = ltrim($message, '\\');
+
+ $this->descriptors[$message] = $descriptor;
+ }
+
+ /**
+ * Obtains the descriptor for the given message class, obtaining
+ * it if not yet loaded.
+ *
+ * @param string|\DrSlump\Protobuf\Message $message
+ * @return \DrSlump\Protobuf\Descriptor
+ */
+ public function getDescriptor($message)
+ {
+ $message = is_object($message) ? get_class($message) : $message;
+ $message = ltrim($message, '\\');
+
+ // Build a descriptor for the message
+ if (!isset($this->descriptors[$message])) {
+ $class = '\\' . $message;
+ if (!class_exists($class)) {
+ throw Protobuf\Exception('Message class "' . $class . '" not available');
+ }
+
+ $this->descriptors[$message] = $class::descriptor();
+ }
+
+ return $this->descriptors[$message];
+ }
+
+ /**
+ * @param string|\DrSlump\Protobuf\Message $message
+ * @return bool
+ */
+ public function hasDescriptor($message)
+ {
+ $message = is_object($message) ? get_class($message) : $message;
+ $message = ltrim($message, '\\');
+
+ return isset($this->descriptors[$message]);
+ }
+
+ /**
+ * @param string|\DrSlump\Protobuf\Message $message
+ */
+ public function unsetDescriptor($message)
+ {
+ $message = is_object($message) ? get_class($message) : $message;
+ $message = ltrim($message, '\\');
+
+ unset($this->descriptors[$message]);
+ }
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/library/DrSlump/Protobuf/Unknown.php
@@ -1,1 +1,10 @@
+<?php
+namespace DrSlump\Protobuf;
+
+abstract class Unknown
+{
+ public $tag = 0;
+ public $data = null;
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/man/protobuf-php.3.ronn
@@ -1,1 +1,118 @@
+protobuf-php(3) -- The framework
+================================
+## SYNOPSIS
+
+ <?php
+ require_once 'DrSlump\Protobuf.php';
+
+ use DrSlump\Protobuf;
+
+ $data = file_get_contents('data.pb');
+ $person = new Tutorial\Person($data);
+ echo $person->getName();
+
+
+## DESCRIPTION
+
+Protobuf-PHP is a library to generate, parse and serialize data structures
+compatible with Google's Protocol Buffers using the PHP language.
+
+## CODECS
+
+The library is designed to work with a pluggable mechanism for encoding and decoding
+messages, allowing it to be used not only to communicate using the standard binary
+format but also with Json or XML based formats.
+
+You can create your own codecs by either extending a provided one or implementing the
+`Protobuf\CodecInterface`. Creating custom codecs offers the possibility to use
+Protobuf-PHP code generation tool to work with legacy formats or even as a simple
+way to interact with database adapters.
+
+### Standard Binary
+
+This is the standard binary format supported by the official libraries distributed
+by Google. It's pretty much compatible with the official implementations although
+there are some known issues, mostly regarding big integer numbers, which are documented
+in the readme file that comes with the library.
+
+### Standard TextFormat
+
+The official libraries also support a text based format for debugging purposes. The
+current implementation of this codec only supports encoding or serialization.
+
+### PhpArray
+
+This is more of an internal codec to ease the implementation of some others. It is
+able to serializa message objects to PHP's associative arrays and intantiate message
+objects from them.
+
+Since most serialization libraries in PHP will natively support associative arrays, this
+codec can be used as an easy way to incorporate those formats for their use
+with Protobuf messages. The Json and XML codecs are examples of this use case.
+
+### JSON
+
+It allows to generate or consume JSON formatted strings, which is a very popular
+format for REST based web services for example. This codec can be used to communicate
+with JavaScript in the browser or with third party REST web services.
+
+### ProtoJson
+
+[ProtoJson](https://github.com/drslump/ProtoJson) allows to apply some payload
+minification strategies when working with JSON formatted messages. Taking advantatge
+of Protobuf's property names mapping to a integer number, it offers two encoding
+variants (_TagMap_ and _Indexed_) that use that number instead of the field name
+as key in the messages to reduce the total size of the payload.
+
+### XML
+
+A very simple codec to work with XML based messages. It has no knowledge of namespaces
+and other advanced XML features but should be enough to integrate with third parties
+that are restricted to simple XML payloads. It can also serve as a base for more
+customized integrations, by extendind this codec to consume and generate XML messages
+specific to your service.
+
+
+
+## ANNOTATED MESSAGES
+
+While the most common use case is to use the protoc-gen-php(1) `protoc` plugin to
+generate source code representing the messages defined in .proto files, it's also
+possible to define messages at runtime without the code generation step.
+
+An easy way to define messages directly in your code is to use the `Protobuf\AnnotatedMessage`
+abstract class, which allows to annotate your classes so that the _codecs_ know how
+to parse and serialize those messages.
+
+ class Person extends \DrSlump\Protobuf\AnnotatedMessage {
+ /** @protobuf(tag=1, type=string, required) */
+ public $name;
+ /** @protobuf(tag=2, type=int32, required) */
+ public $id;
+ /** @protobuf(tag=3, type=string, optional) */
+ public $email;
+ /** @protobuf(tag=4, repeated, type=message, reference=Person) */
+ public $friends = array();
+ }
+
+
+## EXAMPLES
+
+
+
+## BUGS
+
+Please report bugs using GitHub's issue tracker at http://github.com/drslump/protobuf-php/issues
+
+
+## COPYRIGHT
+
+Protobuf for PHP is Copyright (C) 2011 Ivan -DrSlump- Montes <http://pollinimini.net>
+
+
+## SEE ALSO
+
+protoc-gen-php(1), protobuf-php(5),
+<http://github.com/drslump/protobuf-php>
+
--- /dev/null
+++ b/lib/Protobuf-PHP/man/protobuf-php.5.ronn
@@ -1,1 +1,60 @@
+protobuf-php(5) -- Proto files
+================================
+## SYNOPSIS
+
+Protobuf for PHP supports a few custom options for proto files.
+
+
+## DESCRIPTION
+
+Proto files processed with Protobuf for PHP can use a number of custom options
+that affect the generated source code.
+
+ * `php.suffix` <string>:
+ Sets a custom suffix for the generated PHP files. By default ".php" is used.
+
+ * `php.namespace` <string>:
+ Defines the namespace to use for the generated PHP classes.
+
+ * `php.package` <string>:
+ An alias for `php.namespace`
+
+ * `php.multifile` <boolean>:
+ By default a single PHP file is generated for each Proto file processed,
+ including in it all the messages, enums and extensions defined in the proto
+ definition. If this option is set to `true` then each message and enum is
+ generated in a separate file, following PEAR's conventions, and if extensions
+ are pressent in the proto definition a file named after the proto file with the
+ suffix "-extensions" will contain them.
+
+ * `php.generic_services` <boolean>:
+ By default no service interfaces will be generated. If this option is set
+ to true then Interfaces will be created for each `service` definition found,
+ including a method named after each `rpc` entry.
+
+
+
+## EXAMPLES ##
+
+ option (php.suffix) = ".pb.php"
+ option (php.namespace) = "MyOrg.Protos"
+ option (php.multifile) = true
+ option (php.generic_services) = true
+
+
+## BUGS ##
+
+Please report bugs using GitHub's issue tracker at http://github.com/drslump/protobuf-php/issues
+
+
+## COPYRIGHT ##
+
+Protobuf for PHP is Copyright (C) 2011 Ivan -DrSlump- Montes <http://pollinimini.net>
+
+
+## SEE ALSO
+
+protoc-gen-php(1), protobuf-php(3),
+<http://github.com/drslump/protobuf-php>
+
--- /dev/null
+++ b/lib/Protobuf-PHP/man/protoc-gen-php.1.ronn
@@ -1,1 +1,99 @@
+protoc-gen-php(1) -- protoc compiler plugin
+===========================================
+## SYNOPSIS
+
+ `protoc-gen-php` [`-v`] [`-o` _directory_] [`-i` _directory_] <file>...
+
+
+## DESCRIPTION
+
+**protoc-gen-php** is a Google's Protocol Buffers compiler plugin
+for the `protoc` tool. It generates PHP classes compatible with
+**Protobuf for PHP** from .proto files.
+
+
+## REQUIREMENTS ##
+
+**protoc-gen-php** is written in PHP using features first found on
+PHP 5.3. It also requires the Console_CommandLine package from Pear.
+
+Additionally you'll also need to have a working copy of Google Protocol
+Buffers's _protoc_ command, version 2.3 or above, available on your path.
+
+
+## OPTIONS ##
+
+The command accepts the following command-line options (switches).
+
+ * `-v`, `--verbose`:
+ Enables verbose mode. Additional information will be printed when
+ processing the files.
+
+ * `-h`, `--help`:
+ Prints the usage help message and quits.
+
+ * `-i` _directory_, `--include`=_directory_:
+ Tells the protoc compiler to look into that directory when resolving
+ import statements. Note that you can use this switch more than once
+ to configure multiple directories.
+
+ * `-o` _directory_, `--out`=_directory_:
+ Tells the protoc compiler to create generated files in the given
+ directory. If not set it will create the files in the working
+ directory.
+
+ * `--protoc`=_path to protoc binary_:
+ If you don't happen to have the `protoc` binary in your path, you can
+ use this option to indicate a path to it.
+
+ * `--skip-imported`
+ Flags the compiler to only generate source code for the proto file
+ explicitely given on the command line. This means that imported files
+ will not be generated when using this option.
+
+ * `--comments`
+ Parses the .proto files looking for multiline comments (/* ... */) to
+ include them in the generated files.
+
+ * `-Ddefine`, `-Ddefine`=_value_:
+ Defines an option (defaults to true if no value given) to pass to
+ the generator. See protobuf-php(5) for supported options, noting that
+ the `php.` prefix shall not be used here.
+
+
+## EXAMPLES ##
+
+Generate a PHP file from a proto file:
+
+ $ protoc-gen-php tutorial.proto
+
+Generate PHP files in the "build" directory for each proto file found the
+"protos" directory:
+
+ $ protoc-gen-php -o build protos/*.proto
+
+Generate a PHP file from a proto file using imports from an include path:
+
+ $ protoc-gen-php -i ./protos protos/tutorial.proto
+
+Generate a PHP file with a custom extension
+
+ $ protoc-gen-php -Dsuffix=pb.php tutorial.proto
+
+
+## BUGS ##
+
+Please report bugs using GitHub's issue tracker at http://github.com/drslump/protobuf-php/issues
+
+
+## COPYRIGHT ##
+
+Protobuf for PHP is Copyright (C) 2011 Ivan -DrSlump- Montes <http://pollinimini.net>
+
+
+## SEE ALSO
+
+protobuf-php(3), protobuf-php(5),
+<http://github.com/drslump/protobuf-php>
+
--- /dev/null
+++ b/lib/Protobuf-PHP/package.pear
@@ -1,1 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package packagerversion="1.8.0" version="2.0" xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0
+ http://pear.php.net/dtd/tasks-1.0.xsd
+ http://pear.php.net/dtd/package-2.0
+ http://pear.php.net/dtd/package-2.0.xsd">
+ <name>Protobuf</name>
+ <channel>pear.pollinimini.net</channel>
+ <summary>PHP implementation of Google's Protocol Buffers</summary>
+ <description>
+Protobuf for PHP is an implementation of Google's Protocol Buffers for the
+PHP language, supporting its binary data serialization and including a
+protoc plugin to generate PHP classes from .proto files.
+ </description>
+ <lead>
+ <name>Iván -DrSlump- Montes</name>
+ <user>drslump</user>
+ <email>drslump@pollinimini.net</email>
+ <active>yes</active>
+ </lead>
+ <date>{DATE}</date>
+ <time>{TIME}</time>
+ <version>
+ <release>{VERSION}</release>
+ <api>{VERSION}</api>
+ </version>
+ <stability>
+ <release>beta</release>
+ <api>beta</api>
+ </stability>
+ <license uri="http://creativecommons.org/licenses/MIT">The MIT License</license>
+ <notes>http://github.com/drslump/Protobuf-PHP</notes>
+ <contents>
+ <dir name="/">
+ <file baseinstalldir="/" name="LICENSE" role="doc"/>
+ <file baseinstalldir="/" name="README.md" role="doc"/>
+ <file baseinstalldir="/" name="protoc-gen-php.php" role="script">
+ <tasks:replace from="/usr/bin/env php" to="php_bin" type="pear-config"/>
+ <tasks:replace from="@php_bin@" to="php_bin" type="pear-config" />
+ <tasks:replace from="@package_version@" to="version" type="package-info" />
+ </file>
+ <file baseinstalldir="/" name="protoc-gen-php.bat" role="script">
+ <tasks:replace from="@php_bin@" to="php_bin" type="pear-config" />
+ <tasks:replace from="@bin_dir@" to="bin_dir" type="pear-config" />
+ <tasks:replace from="@package_version@" to="version" type="package-info" />
+ </file>
+ {DIRS}
+ </dir>
+ </contents>
+ <dependencies>
+ <required>
+ <php>
+ <min>5.3.0</min>
+ </php>
+ <pearinstaller>
+ <min>1.9.2</min>
+ </pearinstaller>
+ <package>
+ <name>Console_CommandLine</name>
+ <channel>pear.php.net</channel>
+ <min>1.1.0</min>
+ </package>
+ </required>
+ </dependencies>
+ <phprelease>
+ <installconditions>
+ <os>
+ <name>windows</name>
+ </os>
+ </installconditions>
+ <filelist>
+ <install as="protoc-gen-php" name="protoc-gen-php.php" />
+ <install as="protoc-gen-php.bat" name="protoc-gen-php.bat" />
+ </filelist>
+ </phprelease>
+ <phprelease>
+ <filelist>
+ <install as="protoc-gen-php" name="protoc-gen-php.php" />
+ <ignore name="protoc-gen-php.bat" />
+ </filelist>
+ </phprelease>
+</package>
+
--- /dev/null
+++ b/lib/Protobuf-PHP/protoc-gen-php.bat
@@ -1,1 +1,19 @@
+@echo off
+REM Protobuf-PHP
+REM Copyright (C) 2011 Iván -DrSlump- Montes <drslump@pollinimini.net>
+REM
+REM This source file is subject to the MIT license that is bundled
+REM with this package in the file LICENSE.
+REM It is also available through the world-wide-web at this URL:
+REM http://creativecommons.org/licenses/MIT/
+if "%PHPBIN%" == "" set PHPBIN=@php_bin@
+if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH
+GOTO RUN
+
+:USE_PEAR_PATH
+set PHPBIN=%PHP_PEAR_PHP_BIN%
+
+:RUN
+"%PHPBIN%" "@bin_dir@\protoc-gen-php" %*
+
--- /dev/null
+++ b/lib/Protobuf-PHP/protoc-gen-php.php
@@ -1,1 +1,47 @@
+#!/usr/bin/env php
+<?php
+// The MIT License
+//
+// Copyright (c) 2011 Iván -DrSlump- Montes
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+// Set up default timezone
+date_default_timezone_set('GMT');
+
+// For non pear packaged versions use relative include path
+if (strpos('@php_bin@', '@php_bin') === 0) {
+ set_include_path(__DIR__ . DIRECTORY_SEPARATOR . 'library' . PATH_SEPARATOR . get_include_path());
+}
+
+require_once 'DrSlump/Protobuf.php';
+
+// Setup autoloader
+\DrSlump\Protobuf::autoload();
+
+try {
+ // Run the cli interface
+ \DrSlump\Protobuf\Compiler\Cli::run(__FILE__);
+ exit(0);
+
+} catch(Exception $e) {
+ fputs(STDERR, (string)$e . PHP_EOL);
+ exit(1);
+}
+
Binary files /dev/null and b/lib/Protobuf-PHP/protoc.exe differ
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.Codec.Binary.spec.php
@@ -1,1 +1,222 @@
-
+<?php
+
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+error_reporting(E_ALL);
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/repeated.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+describe "Binary Codec"
+
+ before
+
+ $codec = new Protobuf\Codec\Binary();
+ Protobuf::setDefaultCodec($codec);
+
+ $W->bin_simple = file_get_contents(__DIR__ . '/protos/simple.bin');
+ $W->bin_book = file_get_contents(__DIR__ . '/protos/addressbook.bin');
+ $W->bin_repeated_string = file_get_contents(__DIR__ . '/protos/repeated-string.bin');
+ $W->bin_repeated_int32 = file_get_contents(__DIR__ . '/protos/repeated-int32.bin');
+ $W->bin_repeated_nested = file_get_contents(__DIR__ . '/protos/repeated-nested.bin');
+ end;
+
+ describe "serialize"
+
+ it "a simple message comparing types with protoc"
+
+ $max = pow(2, 54)-1;
+ $min = -$max;
+
+ $fields = array(
+ 'double' => array(1, 0.1, 1.0, -1, -0.1, -100000, 123456789.12345, -123456789.12345),
+ 'float' => array(1, 0.1, 1.0, -1, -0.1, -100000, 12345.123, -12345.123),
+ 'int64' => array(0, 1, -1, 123456789123456789, -123456789123456789, $min),
+ 'uint64' => array(0, 1, 1000, 123456789123456789, PHP_INT_MAX, $max),
+ 'int32' => array(0, 1, -1, 123456789, -123456789),
+ 'fixed64' => array(0, 1, 1000, 123456789123456789),
+ 'fixed32' => array(0, 1, 1000, 123456789),
+ 'bool' => array(0, 1),
+ 'string' => array("", "foo"),
+ 'bytes' => array("", "foo"),
+ 'uint32' => array(0, 1, 1000, 123456789),
+ 'sfixed32' => array(0, 1, -1, 123456789, -123456789),
+ 'sfixed64' => array(0, 1, -1, 123456789123456789, -123456789123456789),
+ 'sint32' => array(0, 1, -1, 123456789, -123456789),
+ 'sint64' => array(0, 1, -1, 123456789123456789, -123456789123456789, $min, $max),
+ );
+
+
+ foreach ($fields as $field=>$values) {
+ foreach ($values as $value) {
+ $simple = new Tests\Simple();
+ $simple->$field = $value;
+ $bin = Protobuf::encode($simple);
+
+ if (is_string($value)) $value = '"' . $value . '"';
+
+ exec("echo '$field: $value' | protoc --encode=tests.Simple -Itests tests/protos/simple.proto", $out);
+
+ $out = implode("\n", $out);
+
+ $printValue = var_export($value, true);
+ bin2hex($bin) should eq (bin2hex($out)) as "Encoding $field with value $printValue";
+ }
+ }
+
+ foreach ($fields as $field=>$values) {
+ foreach ($values as $value) {
+ $cmdValue = is_string($value)
+ ? '"' . $value . '"'
+ : $value;
+
+ exec("echo '$field: $cmdValue' | protoc --encode=tests.Simple -Itests tests/protos/simple.proto", $out);
+ $out = implode("\n", $out);
+
+ $simple = Protobuf::decode('\tests\Simple', $out);
+
+ // Hack the comparison for float precision
+ if (is_float($simple->$field)) {
+ $precision = strlen($value) - strpos($value, '.');
+ $simple->$field = round($simple->$field, $precision);
+ }
+
+ $printValue = var_export($value, true);
+ $simple->$field should eq $value as "Decoding $field with value $printValue";
+ }
+ }
+ end.
+
+ it. "a message with repeated fields"
+
+ $repeated = new Tests\Repeated();
+ $repeated->addString('one');
+ $repeated->addString('two');
+ $repeated->addString('three');
+ $bin = Protobuf::encode($repeated);
+ $bin should be $W->bin_repeated_string;
+
+ $repeated = new Tests\Repeated();
+ $repeated->addInt(1);
+ $repeated->addInt(2);
+ $repeated->addInt(3);
+ $bin = Protobuf::encode($repeated);
+ $bin should be $W->bin_repeated_int32;
+
+
+ $repeated = new Tests\Repeated();
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(1);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(2);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(3);
+ $repeated->addNested($nested);
+ $bin = Protobuf::encode($repeated);
+ $bin should eq $W->bin_repeated_nested;
+ end.
+
+ it. "a complex message"
+
+ $book = new Tests\AddressBook();
+ $person = new Tests\Person();
+ $person->name = 'John Doe';
+ $person->id = 2051;
+ $person->email = 'john.doe@gmail.com';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '1231231212';
+ $phone->type = Tests\Person\PhoneType::HOME;
+ $person->addPhone($phone);
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '55512321312';
+ $phone->type = Tests\Person\PhoneType::MOBILE;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $person = new Tests\Person();
+ $person->name = 'Iván Montes';
+ $person->id = 23;
+ $person->email = 'drslump@pollinimini.net';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '3493123123';
+ $phone->type = Tests\Person\PhoneType::WORK;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $bin = Protobuf::encode($book);
+ $bin should eq $W->bin_book but not be false;
+
+ end.
+
+ end;
+
+ describe "unserialize"
+
+ it "a simple message"
+ $simple = Protobuf::decode('Tests\Simple', $W->bin_simple);
+ $simple should be instanceof 'Tests\Simple';
+ $simple->string should be 'foo';
+ $simple->int32 should be -123456789;
+ end.
+
+ it "a message with repeated fields"
+
+ $repeated = Protobuf::decode('Tests\Repeated', $W->bin_repeated_string);
+ $repeated should be instanceof 'Tests\Repeated';
+ $repeated->getString() should eq array('one', 'two', 'three');
+
+ $repeated = Protobuf::decode('Tests\Repeated', $W->bin_repeated_int32);
+ $repeated should be instanceof 'Tests\Repeated';
+ $repeated->getInt() should eq array(1,2,3);
+
+ $repeated = Protobuf::decode('Tests\Repeated', $W->bin_repeated_nested);
+ $repeated should be instanceof 'Tests\Repeated';
+ foreach ($repeated->getNested() as $i=>$nested) {
+ $nested->getId() should eq ($i+1);
+ }
+ end.
+
+ it "a complex message"
+ $complex = Protobuf::decode('Tests\AddressBook', $W->bin_book);
+ count($complex->person) should eq 2;
+ $complex->getPerson(0)->name should eq 'John Doe';
+ $complex->getPerson(1)->name should eq 'Iván Montes';
+ $complex->getPerson(0)->getPhone(1)->number should eq '55512321312';
+ end.
+
+ end;
+
+ describe "multi codec"
+
+ before
+ $W->jsonCodec = new Protobuf\Codec\Json();
+ end
+
+ it "a simple message"
+
+ $simple = Protobuf::decode('Tests\Simple', $W->bin_simple);
+ $json = $W->jsonCodec->encode($simple);
+ $simple = $W->jsonCodec->decode(new \Tests\Simple, $json);
+ $bin = Protobuf::encode($simple);
+ $bin should be $W->bin_simple;
+
+ end.
+
+ it "a message with repeated fields"
+ $repeated = Protobuf::decode('Tests\Repeated', $W->bin_repeated_nested);
+ $json = $W->jsonCodec->encode($repeated);
+ $repeated = $W->jsonCodec->decode(new \Tests\Repeated, $json);
+ $bin = Protobuf::encode($repeated);
+ $bin should be $W->bin_repeated_nested;
+ end.
+
+ end;
+end;
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.Codec.Json.spec.php
@@ -1,1 +1,214 @@
-
+<?php
+
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/repeated.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+include_once __DIR__ . '/protos/Annotated/Simple.php';
+include_once __DIR__ . '/protos/Annotated/Repeated.php';
+include_once __DIR__ . '/protos/Annotated/Addressbook.php';
+
+
+describe "JSON Codec"
+
+ before
+ Protobuf::setDefaultCodec(new ProtoBuf\Codec\Json);
+ end
+
+ describe "serialize"
+
+ it "a simple message"
+ $simple = new Tests\Simple();
+ $simple->string = 'FOO';
+ $simple->int32 = 1000;
+ $json = Protobuf::encode($simple);
+ $json. should. eq. '{"int32":1000,"string":"FOO"}';
+ end.
+
+ it. "a message with repeated fields"
+
+ $repeated = new \Tests\Repeated();
+ $repeated->addString('one');
+ $repeated->addString('two');
+ $repeated->addString('three');
+ $bin = Protobuf::encode($repeated);
+ $bin should be '{"string":["one","two","three"]}';
+
+ $repeated = new Tests\Repeated();
+ $repeated->addInt(1);
+ $repeated->addInt(2);
+ $repeated->addInt(3);
+ $bin = Protobuf::encode($repeated);
+ $bin should be '{"int":[1,2,3]}';
+
+ $repeated = new Tests\Repeated();
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(1);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(2);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(3);
+ $repeated->addNested($nested);
+ $json = Protobuf::encode($repeated);
+ $json should eq '{"nested":[{"id":1},{"id":2},{"id":3}]}';
+ end.
+
+ it. "a complex message"
+
+ $book = new Tests\AddressBook();
+ $person = new Tests\Person();
+ $person->name = 'John Doe';
+ $person->id = 2051;
+ $person->email = 'john.doe@gmail.com';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '1231231212';
+ $phone->type = Tests\Person\PhoneType::HOME;
+ $person->addPhone($phone);
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '55512321312';
+ $phone->type = Tests\Person\PhoneType::MOBILE;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $person = new Tests\Person();
+ $person->name = 'Iván Montes';
+ $person->id = 23;
+ $person->email = 'drslump@pollinimini.net';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '3493123123';
+ $phone->type = Tests\Person\PhoneType::WORK;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $json = Protobuf::encode($book);
+
+ $expected = '{
+ "person":[
+ {
+ "name":"John Doe",
+ "id":2051,
+ "email":"john.doe@gmail.com",
+ "phone":[
+ {"number":"1231231212","type":1},
+ {"number":"55512321312","type":0}
+ ]
+ },
+ {
+ "name":"Iv\u00e1n Montes",
+ "id":23,
+ "email":"drslump@pollinimini.net",
+ "phone":[{"number":"3493123123","type":2}]
+ }
+ ]
+ }';
+
+ $expected = preg_replace('/\n\s*/', '', $expected);
+
+ $json should be $expected;
+ end.
+
+ it "an annotated simple message"
+ $simple = new tests\Annotated\Simple();
+ $simple->foo = 'FOO';
+ $simple->bar = 1000;
+ $json = Protobuf::encode($simple);
+ $json. should. eq. '{"foo":"FOO","bar":1000}';
+ end.
+
+ it "an annotated message with repeated fields"
+ $repeated = new \Tests\Annotated\Repeated();
+ $repeated->string = array('one', 'two', 'three');
+ $bin = Protobuf::encode($repeated);
+ $bin should be '{"string":["one","two","three"]}';
+
+ $repeated = new Tests\Annotated\Repeated();
+ $repeated->int = array(1,2,3);
+ $bin = Protobuf::encode($repeated);
+ $bin should be '{"int":[1,2,3]}';
+
+ $repeated = new Tests\Annotated\Repeated();
+ $repeated->nested = array();
+ $nested = new Tests\Annotated\RepeatedNested();
+ $nested->id = 1;
+ $repeated->nested[] = $nested;
+ $nested = new Tests\Annotated\RepeatedNested();
+ $nested->id = 2;
+ $repeated->nested[] = $nested;
+ $nested = new Tests\Annotated\RepeatedNested();
+ $nested->id = 3;
+ $repeated->nested[] = $nested;
+ $json = Protobuf::encode($repeated);
+ $json should eq '{"nested":[{"id":1},{"id":2},{"id":3}]}';
+ end.
+ end;
+
+ describe "unserialize"
+
+ it "should unserialize a simple message"
+ $json = '{"string":"FOO","int32":1000}';
+ $simple = Protobuf::decode('Tests\Simple', $json);
+ $simple should be instanceof 'Tests\Simple';
+ $simple->string should equal 'FOO';
+ $simple->int32 should equal 1000;
+ end.
+
+ it "a message with repeated fields"
+
+ $json = '{"string":["one","two","three"]}';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated->getString() should eq array('one', 'two', 'three');
+
+ $json = '{"int":[1,2,3]}';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated should be instanceof 'Tests\Repeated';
+ $repeated->getInt() should eq array(1,2,3);
+
+ $json = '{"nested":[{"id":1},{"id":2},{"id":3}]}';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated should be instanceof 'Tests\Repeated';
+ foreach ($repeated->getNested() as $i=>$nested) {
+ $nested->getId() should eq ($i+1);
+ }
+ end.
+
+ it "a complex message"
+ $json = '{
+ "person":[
+ {
+ "name":"John Doe",
+ "id":2051,
+ "email":"john.doe@gmail.com",
+ "phone":[
+ {"number":"1231231212","type":1},
+ {"number":"55512321312","type":0}
+ ]
+ },
+ {
+ "name":"Iv\u00e1n Montes",
+ "id":23,
+ "email":"drslump@pollinimini.net",
+ "phone":[{"number":"3493123123","type":2}]
+ }
+ ]
+ }';
+
+ $json = preg_replace('/\n\s*/', '', $json);
+
+ $complex = Protobuf::decode('Tests\AddressBook', $json);
+ count($complex->person) should eq 2;
+ $complex->getPerson(0)->name should eq 'John Doe';
+ $complex->getPerson(1)->name should eq 'Iván Montes';
+ $complex->getPerson(0)->getPhone(1)->number should eq '55512321312';
+ end.
+
+ end;
+end;
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.Codec.JsonIndexed.spec.php
@@ -1,1 +1,187 @@
+<?php
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/repeated.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+describe "JSON Indexed Codec"
+
+ before
+ Protobuf::setDefaultCodec(new Protobuf\Codec\JsonIndexed);
+ end
+
+ describe "serialize"
+
+ it "should serialize a simple message"
+ $simple = new Tests\Simple();
+ $simple->string = 'FOO';
+ $simple->int32 = 1000;
+ $json = Protobuf::encode($simple);
+ $json. should. eq. '["59",1000,"FOO"]';
+ end.
+
+ it. "a message with repeated fields"
+
+ $repeated = new Tests\Repeated();
+ $repeated->addString('one');
+ $repeated->addString('two');
+ $repeated->addString('three');
+ $bin = Protobuf::encode($repeated);
+ $bin should be '["1",["one","two","three"]]';
+
+ $repeated = new Tests\Repeated();
+ $repeated->addInt(1);
+ $repeated->addInt(2);
+ $repeated->addInt(3);
+ $bin = Protobuf::encode($repeated);
+ $bin should be '["2",[1,2,3]]';
+
+ $repeated = new Tests\Repeated();
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(1);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(2);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(3);
+ $repeated->addNested($nested);
+ $json = Protobuf::encode($repeated);
+ $json should eq '["3",[["1",1],["1",2],["1",3]]]';
+ end.
+
+ it. "a complex message"
+
+ $book = new Tests\AddressBook();
+ $person = new Tests\Person();
+ $person->name = 'John Doe';
+ $person->id = 2051;
+ $person->email = 'john.doe@gmail.com';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '1231231212';
+ $phone->type = Tests\Person\PhoneType::HOME;
+ $person->addPhone($phone);
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '55512321312';
+ $phone->type = Tests\Person\PhoneType::MOBILE;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $person = new Tests\Person();
+ $person->name = 'Iván Montes';
+ $person->id = 23;
+ $person->email = 'drslump@pollinimini.net';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '3493123123';
+ $phone->type = Tests\Person\PhoneType::WORK;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $json = Protobuf::encode($book);
+
+ $expected = '[
+ "1",
+ [
+ [
+ "1234",
+ "John Doe",
+ 2051,
+ "john.doe@gmail.com",
+ [
+ ["12","1231231212",1],
+ ["12","55512321312",0]
+ ]
+ ],
+ [
+ "1234",
+ "Iv\u00e1n Montes",
+ 23,
+ "drslump@pollinimini.net",
+ [
+ ["12","3493123123",2]
+ ]
+ ]
+ ]
+ ]';
+
+ $expected = preg_replace('/\n\s*/', '', $expected);
+
+ $json should be $expected;
+ end.
+ end;
+
+ describe "unserialize"
+
+ it "should unserialize a simple message"
+ $json = '["59",1000,"FOO"]';
+ $simple = Protobuf::decode('Tests\Simple', $json);
+ $simple should be instanceof 'Tests\Simple';
+ $simple->string should equal 'FOO';
+ $simple->int32 should equal 1000;
+ end.
+
+ it "a message with repeated fields"
+
+ $json = '["1",["one","two","three"]]';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated->getString() should eq array('one', 'two', 'three');
+
+ $json = '["2",[1,2,3]]';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated should be instanceof 'Tests\Repeated';
+ $repeated->getInt() should eq array(1,2,3);
+
+ $json = '["3",[["1",1],["1",2],["1",3]]]';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated should be instanceof 'Tests\Repeated';
+ foreach ($repeated->getNested() as $i=>$nested) {
+ $nested->getId() should eq ($i+1);
+ }
+ end.
+
+ it "a complex message"
+ $json = '[
+ "1",
+ [
+ [
+ "1234",
+ "John Doe",
+ 2051,
+ "john.doe@gmail.com",
+ [
+ ["12","1231231212",1],
+ ["12","55512321312",0]
+ ]
+ ],
+ [
+ "1234",
+ "Iv\u00e1n Montes",
+ 23,
+ "drslump@pollinimini.net",
+ [
+ ["12","3493123123",2]
+ ]
+ ]
+ ]
+ ]';
+
+ $json = preg_replace('/\n\s*/', '', $json);
+
+ $complex = Protobuf::decode('Tests\AddressBook', $json);
+ count($complex->person) should eq 2;
+ $complex->getPerson(0)->name should eq 'John Doe';
+ $complex->getPerson(1)->name should eq 'Iván Montes';
+ $complex->getPerson(0)->getPhone(1)->number should eq '55512321312';
+ end.
+
+
+
+ end;
+end;
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.Codec.JsonTagMap.spec.php
@@ -1,1 +1,175 @@
+<?php
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/repeated.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+describe "JSON TagMap Codec"
+
+ before
+ Protobuf::setDefaultCodec(new Protobuf\Codec\JsonTagMap);
+ end
+
+ describe "serialize"
+
+ it "should serialize a simple message"
+ $simple = new Tests\Simple();
+ $simple->string = 'FOO';
+ $simple->int32 = 1000;
+ $json = Protobuf::encode($simple);
+ $json. should. eq. '{"5":1000,"9":"FOO"}';
+ end.
+
+ it. "a message with repeated fields"
+
+ $repeated = new Tests\Repeated();
+ $repeated->addString('one');
+ $repeated->addString('two');
+ $repeated->addString('three');
+ $bin = Protobuf::encode($repeated);
+ $bin should be '{"1":["one","two","three"]}';
+
+ $repeated = new Tests\Repeated();
+ $repeated->addInt(1);
+ $repeated->addInt(2);
+ $repeated->addInt(3);
+ $bin = Protobuf::encode($repeated);
+ $bin should be '{"2":[1,2,3]}';
+
+ $repeated = new Tests\Repeated();
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(1);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(2);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(3);
+ $repeated->addNested($nested);
+ $json = Protobuf::encode($repeated);
+ $json should eq '{"3":[{"1":1},{"1":2},{"1":3}]}';
+ end.
+
+ it. "a complex message"
+
+ $book = new Tests\AddressBook();
+ $person = new Tests\Person();
+ $person->name = 'John Doe';
+ $person->id = 2051;
+ $person->email = 'john.doe@gmail.com';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '1231231212';
+ $phone->type = Tests\Person\PhoneType::HOME;
+ $person->addPhone($phone);
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '55512321312';
+ $phone->type = Tests\Person\PhoneType::MOBILE;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $person = new Tests\Person();
+ $person->name = 'Iván Montes';
+ $person->id = 23;
+ $person->email = 'drslump@pollinimini.net';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '3493123123';
+ $phone->type = Tests\Person\PhoneType::WORK;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $json = Protobuf::encode($book);
+
+ $expected = '{
+ "1":[
+ {
+ "1":"John Doe",
+ "2":2051,
+ "3":"john.doe@gmail.com",
+ "4":[
+ {"1":"1231231212","2":1},
+ {"1":"55512321312","2":0}
+ ]
+ },
+ {
+ "1":"Iv\u00e1n Montes",
+ "2":23,
+ "3":"drslump@pollinimini.net",
+ "4":[{"1":"3493123123","2":2}]
+ }
+ ]
+ }';
+
+ $expected = preg_replace('/\n\s*/', '', $expected);
+
+ $json should be $expected;
+ end.
+ end;
+
+ describe "unserialize"
+
+ it "should unserialize a simple message"
+ $json = '{"9":"FOO","5":1000}';
+ $simple = Protobuf::decode('Tests\Simple', $json);
+ $simple should be instanceof 'Tests\Simple';
+ $simple->string should equal 'FOO';
+ $simple->int32 should equal 1000;
+ end.
+
+ it "a message with repeated fields"
+
+ $json = '{"1":["one","two","three"]}';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated->getString() should eq array('one', 'two', 'three');
+
+ $json = '{"2":[1,2,3]}';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated should be instanceof 'Tests\Repeated';
+ $repeated->getInt() should eq array(1,2,3);
+
+ $json = '{"3":[{"1":1},{"1":2},{"1":3}]}';
+ $repeated = Protobuf::decode('Tests\Repeated', $json);
+ $repeated should be instanceof 'Tests\Repeated';
+ foreach ($repeated->getNested() as $i=>$nested) {
+ $nested->getId() should eq ($i+1);
+ }
+ end.
+
+ it "a complex message"
+ $json = '{
+ "1":[
+ {
+ "1":"John Doe",
+ "2":2051,
+ "3":"john.doe@gmail.com",
+ "4":[
+ {"1":"1231231212","2":1},
+ {"1":"55512321312","2":0}
+ ]
+ },
+ {
+ "1":"Iv\u00e1n Montes",
+ "2":23,
+ "3":"drslump@pollinimini.net",
+ "4":[{"1":"3493123123","2":2}]
+ }
+ ]
+ }';
+
+ $json = preg_replace('/\n\s*/', '', $json);
+
+ $complex = Protobuf::decode('Tests\AddressBook', $json);
+ count($complex->person) should eq 2;
+ $complex->getPerson(0)->name should eq 'John Doe';
+ $complex->getPerson(1)->name should eq 'Iván Montes';
+ $complex->getPerson(0)->getPhone(1)->number should eq '55512321312';
+ end.
+
+ end;
+end;
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.Codec.TextFormat.spec.php
@@ -1,1 +1,131 @@
+<?php
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/repeated.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+describe "TextFormat Codec"
+
+ before
+ Protobuf::setDefaultCodec(new ProtoBuf\Codec\TextFormat);
+ end
+
+ describe "serialize"
+
+ it "should serialize a simple message"
+ $simple = new Tests\Simple();
+ $simple->string = 'FOO';
+ $simple->int32 = 1000;
+ $txt = Protobuf::encode($simple);
+ $txt . should. be. "int32: 1000\nstring: \"FOO\"\n";
+ end.
+
+ it. "a message with repeated fields"
+
+ $repeated = new \Tests\Repeated();
+ $repeated->addString('one');
+ $repeated->addString('two');
+ $repeated->addString('three');
+ $txt = Protobuf::encode($repeated);
+ $txt should be "string: \"one\"\nstring: \"two\"\nstring: \"three\"\n";
+
+ $repeated = new Tests\Repeated();
+ $repeated->addInt(1);
+ $repeated->addInt(2);
+ $repeated->addInt(3);
+ $txt = Protobuf::encode($repeated);
+ $txt should be "int: 1\nint: 2\nint: 3\n";
+
+ $repeated = new Tests\Repeated();
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(1);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(2);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(3);
+ $repeated->addNested($nested);
+ $txt = Protobuf::encode($repeated);
+ $txt should eq "nested {\n id: 1\n}\nnested {\n id: 2\n}\nnested {\n id: 3\n}\n";
+ end.
+
+ it. "a complex message"
+
+ $book = new Tests\AddressBook();
+ $person = new Tests\Person();
+ $person->name = 'John Doe';
+ $person->id = 2051;
+ $person->email = 'john.doe@gmail.com';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '1231231212';
+ $phone->type = Tests\Person\PhoneType::HOME;
+ $person->addPhone($phone);
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '55512321312';
+ $phone->type = Tests\Person\PhoneType::MOBILE;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $person = new Tests\Person();
+ $person->name = 'Iván Montes';
+ $person->id = 23;
+ $person->email = 'drslump@pollinimini.net';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '3493123123';
+ $phone->type = Tests\Person\PhoneType::WORK;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $txt = Protobuf::encode($book);
+ $txt = str_replace(' ', '', $txt);
+ $txt = trim($txt);
+
+ $expected = '
+ person {
+ name: "John Doe"
+ id: 2051
+ email: "john.doe@gmail.com"
+ phone {
+ number: "1231231212"
+ type: 1
+ }
+ phone {
+ number: "55512321312"
+ type: 0
+ }
+ }
+ person {
+ name: "Iv\u00e1n Montes"
+ id: 23
+ email: "drslump@pollinimini.net"
+ phone {
+ number: "3493123123"
+ type: 2
+ }
+ }
+ ';
+
+ $expected = str_replace(' ', '', $expected);
+ $expected = trim($expected);
+
+ $txt should be $expected;
+ end.
+ end;
+
+ describe "unserialize"
+
+ # throws \BadMethodCallException
+ it "TextFormat does not implement decoding"
+ $txt = "foo: \"FOO\"\nbar: \"BAR\"\n";
+ $simple = Protobuf::decode('Tests\Simple', $txt);
+ end.
+ end;
+end;
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.Codec.Xml.spec.php
@@ -1,1 +1,178 @@
+<?php
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/repeated.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+describe "XML Codec"
+
+ before
+ Protobuf::setDefaultCodec(new ProtoBuf\Codec\Xml);
+ end
+
+ describe "serialize"
+
+ it "a simple message"
+ $simple = new Tests\Simple();
+ $simple->string = 'FOO';
+ $simple->int32 = 1000;
+ $xml = Protobuf::encode($simple);
+ $sxe = simplexml_load_string($xml);
+ $sxe->string should eq "FOO";
+ $sxe->int32 should eq 1000;
+ end.
+
+ it. "a message with repeated fields"
+
+ $repeated = new \Tests\Repeated();
+ $repeated->addString('one');
+ $repeated->addString('two');
+ $repeated->addString('three');
+ $xml = Protobuf::encode($repeated);
+ $xml = simplexml_load_string($xml);
+ $xml->string[0] should eq 'one';
+ $xml->string[1] should eq 'two';
+ $xml->string[2] should eq 'three';
+
+ $repeated = new Tests\Repeated();
+ $repeated->addInt(1);
+ $repeated->addInt(2);
+ $repeated->addInt(3);
+ $xml = Protobuf::encode($repeated);
+ $xml = simplexml_load_string($xml);
+ $xml->int[0] should eq 1;
+ $xml->int[1] should eq 2;
+ $xml->int[2] should eq 3;
+
+ $repeated = new Tests\Repeated();
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(1);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(2);
+ $repeated->addNested($nested);
+ $nested = new Tests\Repeated\Nested();
+ $nested->setId(3);
+ $repeated->addNested($nested);
+ $xml = Protobuf::encode($repeated);
+ $xml = simplexml_load_string($xml);
+ $xml->nested[0]->id should eq 1;
+ $xml->nested[1]->id should eq 2;
+ $xml->nested[2]->id should eq 3;
+ end.
+
+ it. "a complex message"
+
+ $book = new Tests\AddressBook();
+ $person = new Tests\Person();
+ $person->name = 'John Doe';
+ $person->id = 2051;
+ $person->email = 'john.doe@gmail.com';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '1231231212';
+ $phone->type = Tests\Person\PhoneType::HOME;
+ $person->addPhone($phone);
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '55512321312';
+ $phone->type = Tests\Person\PhoneType::MOBILE;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $person = new Tests\Person();
+ $person->name = 'Iván Montes';
+ $person->id = 23;
+ $person->email = 'drslump@pollinimini.net';
+ $phone = new Tests\Person\PhoneNumber;
+ $phone->number = '3493123123';
+ $phone->type = Tests\Person\PhoneType::WORK;
+ $person->addPhone($phone);
+ $book->addPerson($person);
+
+ $xml = Protobuf::encode($book);
+ $xml = simplexml_load_string($xml);
+
+ $xml->person[0]->name should eq "John Doe";
+ $xml->person[0]->phone[1]->number should eq "55512321312";
+ $xml->person[1]->id should eq 23;
+ $xml->person[1]->phone[0]->type should eq 2;
+ end.
+ end;
+
+ describe "unserialize"
+
+ it "should unserialize a simple message"
+ $xml = new SimpleXmlElement('<root></root>');
+ $xml->addChild('string', 'FOO');
+ $xml->addChild('int32', 1000);
+
+ $simple = Protobuf::decode('Tests\Simple', $xml);
+ $simple should be instanceof 'Tests\Simple';
+ $simple->string should equal 'FOO';
+ $simple->int32 should equal 1000;
+ end.
+
+ it "a message with repeated fields"
+
+ $xml = new SimpleXMLElement('<root></root>');
+ $xml->addChild('string', 'one');
+ $xml->addChild('string', 'two');
+ $xml->addChild('string', 'three');
+
+ $repeated = Protobuf::decode('Tests\Repeated', $xml);
+ $repeated->getString() should eq array('one', 'two', 'three');
+
+ $xml = new SimpleXMLElement('<root></root>');
+ $xml->addChild('int', 1);
+ $xml->addChild('int', 2);
+ $xml->addChild('int', 3);
+
+ $repeated = Protobuf::decode('Tests\Repeated', $xml);
+ $repeated should be instanceof 'Tests\Repeated';
+ $repeated->getInt() should eq array(1,2,3);
+
+ $xml = new SimpleXMLElement('<root></root>');
+ $xml->addChild('nested')->addChild('id', 1);
+ $xml->addChild('nested')->addChild('id', 2);
+ $xml->addChild('nested')->addChild('id', 3);
+
+ $repeated = Protobuf::decode('Tests\Repeated', $xml);
+ $repeated should be instanceof 'Tests\Repeated';
+ foreach ($repeated->getNested() as $i=>$nested) {
+ $nested->getId() should eq ($i+1);
+ }
+ end.
+
+ it "a complex message"
+
+ $xml = new SimpleXMLElement('<root></root>');
+ $p = $xml->addChild('person');
+ $p->addChild('name', 'John Doe');
+ $p->addChild('id', 2051);
+ $p->addChild('email', 'john.doe@gmail.com');
+ $p = $p->addChild('phone');
+ $p->addChild('number', '1231231212');
+ $p->addChild('type', 1);
+ $p = $xml->addChild('person');
+ $p->addChild('name', 'Iván Montes');
+ $p->addChild('id', 23);
+ $p->addChild('email', 'drslump@pollinimini.net');
+ $p = $p->addChild('phone');
+ $p->addChild('number', '3493123123');
+ $p->addChild('type', 2);
+
+ $complex = Protobuf::decode('Tests\AddressBook', $xml->asXML());
+ count($complex->person) should eq 2;
+ $complex->getPerson(0)->name should eq 'John Doe';
+ $complex->getPerson(1)->name should eq 'Iván Montes';
+ $complex->getPerson(1)->getPhone(0)->number should eq '3493123123';
+ end.
+
+ end;
+end;
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/Protobuf.spec.php
@@ -1,1 +1,65 @@
+<?php
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use DrSlump\Protobuf;
+
+describe 'Protobuf'
+
+ //before
+ Protobuf::autoload();
+ //end
+
+ it 'should autoload classes'
+ new Protobuf\Codec\Binary();
+ end.
+
+ describe 'codecs registry'
+ it 'should get a default codec if none set'
+ $codec = Protobuf::getCodec();
+ $codec should be an instance of '\DrSlump\Protobuf\CodecInterface';
+ end.
+
+ it 'should return the passed codec instance'
+ $passed = new Protobuf\Codec\Binary();
+ $getted = Protobuf::getCodec($passed);
+ $getted should be $passed
+ end.
+
+ it. 'should register a new codec'
+ $setted = new Protobuf\Codec\Binary();
+ Protobuf::registerCodec('test', $setted);
+ $getted = Protobuf::getCodec('test');
+ $getted should be $setted
+ end.
+
+ it 'should register a new default codec'
+ $setted = new Protobuf\Codec\Binary();
+ Protobuf::setDefaultCodec($setted);
+ Protobuf::getCodec() should be $setted
+ end.
+
+ # throws DrSlump\Protobuf\Exception
+ it. 'should unregister a codec'
+ $setted = new Protobuf\Codec\Binary();
+ Protobuf::registerCodec('test', $setted);
+ $result = Protobuf::unregisterCodec('test');
+ $result should be true;
+ // If not set throws an exception
+ Protobuf::getCodec('test');
+ end.
+
+ it. 'should unregister the default codec'
+ $result = Protobuf::unregisterCodec('default');
+ $result should be true;
+ // Ensure a new default is given
+ $getted = Protobuf::getCodec();
+ $getted should be instanceof 'DrSlump\Protobuf\Codec\Binary'
+ end.
+ end;
+end;
+
+
+
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/benchmark.php
@@ -1,1 +1,74 @@
+<?php
+require_once 'Benchmark/Profiler.php';
+require_once __DIR__ . '/../library/DrSlump/Protobuf.php';
+
+use \DrSlump\Protobuf;
+
+Protobuf::autoload();
+
+include_once __DIR__ . '/protos/simple.php';
+include_once __DIR__ . '/protos/addressbook.php';
+
+
+class Benchmark {
+
+ protected $tests = array(
+ 'DecodeBinarySimple',
+ 'DecodeJsonSimple',
+ );
+
+ public function run($iterations = 1000)
+ {
+ $profiler = new Benchmark_Profiler(true);
+ foreach ($this->tests as $test) {
+ $method = 'config' . $test;
+ $args = $this->$method();
+
+ $method = 'run' . $test;
+ $profiler->enterSection($test);
+ for ($i=0; $i<$iterations; $i++) {
+ call_user_func_array(array($this, $method), $args);
+ }
+ $profiler->leaveSection($test);
+ }
+
+ $profiler->stop();
+ $profiler->display();
+ }
+
+ protected function configDecodeBinarySimple()
+ {
+ return array(
+ new Protobuf\Codec\Binary(),
+ file_get_contents(__DIR__ . '/protos/simple.bin')
+ );
+ }
+
+ protected function runDecodeBinarySimple($codec, $data)
+ {
+ $codec->decode(new tests\Simple(), $data);
+ }
+
+ protected function configDecodeJsonSimple()
+ {
+ $codecBin = new Protobuf\Codec\Binary();
+ $codecJson = new Protobuf\Codec\Json();
+
+ $bin = $this->configDecodeBinarySimple();
+ $simple = $codecBin->decode(new tests\Simple(), $bin[1]);
+ $data = $codecJson->encode($simple);
+ return array($codecJson, $data);
+ }
+
+ protected function runDecodeJsonSimple($codec, $data)
+ {
+ $codec->decode(new tests\Simple(), $data);
+ }
+}
+
+
+$bench = new Benchmark();
+$bench->run(1000);
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/Annotated/Addressbook.php
@@ -1,1 +1,10 @@
+<?php
+/**
+ * Created by IntelliJ IDEA.
+ * User: drslump
+ * Date: 6/27/11
+ * Time: 12:48 AM
+ * To change this template use File | Settings | File Templates.
+ */
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/Annotated/Repeated.php
@@ -1,1 +1,20 @@
+<?php
+namespace Tests\Annotated;
+
+class Repeated extends \DrSlump\Protobuf\AnnotatedMessage
+{
+ /** @protobuf(tag=1, type=string, repeated) */
+ public $string;
+ /** @protobuf(tag=2, type=int32, repeated) */
+ public $int;
+ /** @protobuf(tag=3, type=message, reference=tests\Annotated\RepeatedNested, repeated) */
+ public $nested;
+}
+
+class RepeatedNested extends \DrSlump\Protobuf\AnnotatedMessage
+{
+ /** @protobuf(tag=1, type=int32) */
+ public $id;
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/Annotated/Simple.php
@@ -1,1 +1,14 @@
+<?php
+namespace Tests\Annotated;
+
+class Simple extends \DrSlump\Protobuf\AnnotatedMessage
+{
+ /** @protobuf(tag=1, type=string, required) */
+ public $foo;
+ /** @protobuf(tag=2, type=int32, required) */
+ public $bar;
+ /** @protobuf(tag=3, type=string, optional) */
+ public $baz;
+}
+
Binary files /dev/null and b/lib/Protobuf-PHP/tests/protos/addressbook.bin differ
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/addressbook.php
@@ -1,1 +1,460 @@
-
+<?php
+// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin @package_version@
+// Source: addressbook.proto
+// Date: 2011-04-13 17:07:17
+
+namespace tests {
+
+ class Person extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor('\tests\Person');
+
+ // required name = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "name";
+ $f->type = 9;
+ $f->rule = 2;
+ $descriptor->addField($f);
+
+ // required id = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "id";
+ $f->type = 5;
+ $f->rule = 2;
+ $descriptor->addField($f);
+
+ // optional email = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "email";
+ $f->type = 9;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ // repeated .tests.Person.PhoneNumber phone = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "phone";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\tests\Person\PhoneNumber';
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $name = null;
+
+ /** @var int */
+ public $id = null;
+
+ /** @var string */
+ public $email = null;
+
+ /** @var \tests\Person\PhoneNumber[] */
+ public $phone = array();
+
+
+ /**
+ * Check if <name> has a value
+ *
+ * @return boolean
+ */
+ public function hasName(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <name> value
+ *
+ * @return \tests\Person
+ */
+ public function clearName(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <name> value
+ *
+ * @return string
+ */
+ public function getName(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <name> value
+ *
+ * @param string $value
+ * @return \tests\Person
+ */
+ public function setName( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <id> has a value
+ *
+ * @return boolean
+ */
+ public function hasId(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <id> value
+ *
+ * @return \tests\Person
+ */
+ public function clearId(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <id> value
+ *
+ * @return int
+ */
+ public function getId(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <id> value
+ *
+ * @param int $value
+ * @return \tests\Person
+ */
+ public function setId( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <email> has a value
+ *
+ * @return boolean
+ */
+ public function hasEmail(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <email> value
+ *
+ * @return \tests\Person
+ */
+ public function clearEmail(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <email> value
+ *
+ * @return string
+ */
+ public function getEmail(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <email> value
+ *
+ * @param string $value
+ * @return \tests\Person
+ */
+ public function setEmail( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <phone> has a value
+ *
+ * @return boolean
+ */
+ public function hasPhone(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <phone> value
+ *
+ * @return \tests\Person
+ */
+ public function clearPhone(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <phone> value
+ *
+ * @param int $idx
+ * @return \tests\Person\PhoneNumber
+ */
+ public function getPhone($idx = NULL){
+ return $this->_get(4, $idx);
+ }
+
+ /**
+ * Set <phone> value
+ *
+ * @param \tests\Person\PhoneNumber $value
+ * @return \tests\Person
+ */
+ public function setPhone(\tests\Person\PhoneNumber $value, $idx = NULL){
+ return $this->_set(4, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <phone>
+ *
+ * @return \tests\Person\PhoneNumber[]
+ */
+ public function getPhoneList(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Add a new element to <phone>
+ *
+ * @param \tests\Person\PhoneNumber $value
+ * @return \tests\Person
+ */
+ public function addPhone(\tests\Person\PhoneNumber $value){
+ return $this->_add(4, $value);
+ }
+
+ }
+}
+
+namespace tests\Person {
+
+ class PhoneType {
+ const MOBILE = 0;
+ const HOME = 1;
+ const WORK = 2;
+ }
+}
+
+namespace tests\Person {
+
+ class PhoneNumber extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor('\tests\Person\PhoneNumber');
+
+ // required number = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "number";
+ $f->type = 9;
+ $f->rule = 2;
+ $descriptor->addField($f);
+
+ // optional .tests.Person.PhoneType type = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "type";
+ $f->type = 14;
+ $f->rule = 1;
+ $f->reference = '\tests\Person\PhoneType';
+ $f->default = \tests\Person\PhoneType::HOME;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ return $descriptor;
+ }
+
+ /** @var string */
+ public $number = null;
+
+ /** @var int - \tests\Person\PhoneType */
+ public $type = \tests\Person\PhoneType::HOME;
+
+
+ /**
+ * Check if <number> has a value
+ *
+ * @return boolean
+ */
+ public function hasNumber(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <number> value
+ *
+ * @return \tests\Person\PhoneNumber
+ */
+ public function clearNumber(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <number> value
+ *
+ * @return string
+ */
+ public function getNumber(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <number> value
+ *
+ * @param string $value
+ * @return \tests\Person\PhoneNumber
+ */
+ public function setNumber( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <type> has a value
+ *
+ * @return boolean
+ */
+ public function hasType(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <type> value
+ *
+ * @return \tests\Person\PhoneNumber
+ */
+ public function clearType(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <type> value
+ *
+ * @return int - \tests\Person\PhoneType
+ */
+ public function getType(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <type> value
+ *
+ * @param int - \tests\Person\PhoneType $value
+ * @return \tests\Person\PhoneNumber
+ */
+ public function setType( $value){
+ return $this->_set(2, $value);
+ }
+
+ }
+}
+
+namespace tests {
+
+ class AddressBook extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor('\tests\AddressBook');
+
+ // repeated .tests.Person person = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "person";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\tests\Person';
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ return $descriptor;
+ }
+
+ /** @var \tests\Person[] */
+ public $person = array();
+
+
+ /**
+ * Check if <person> has a value
+ *
+ * @return boolean
+ */
+ public function hasPerson(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <person> value
+ *
+ * @return \tests\AddressBook
+ */
+ public function clearPerson(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <person> value
+ *
+ * @param int $idx
+ * @return \tests\Person
+ */
+ public function getPerson($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <person> value
+ *
+ * @param \tests\Person $value
+ * @return \tests\AddressBook
+ */
+ public function setPerson(\tests\Person $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <person>
+ *
+ * @return \tests\Person[]
+ */
+ public function getPersonList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <person>
+ *
+ * @param \tests\Person $value
+ * @return \tests\AddressBook
+ */
+ public function addPerson(\tests\Person $value){
+ return $this->_add(1, $value);
+ }
+
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/addressbook.proto
@@ -1,1 +1,44 @@
+import "php.proto";
+package tests;
+
+//option (php.namespace) = "Example";
+//option (php.multifile) = true;
+
+/**
+ * Defines a Person in the addressbook
+ */
+message Person {
+ /* The full name of the person */
+ required string name = 1;
+ /* The person Id in the database */
+ required int32 id = 2;
+ /* The person email */
+ optional string email = 3;
+
+ /* Different types of phones */
+ enum PhoneType {
+ MOBILE = 0;
+ HOME = 1;
+ WORK = 2;
+ }
+
+ /*
+ A phone number record
+ */
+ message PhoneNumber {
+ required string number = 1;
+ optional PhoneType type = 2 [default = HOME];
+ }
+
+ /* The different phone numbers associated to a person */
+ repeated PhoneNumber phone = 4;
+}
+
+/* A collection of persons contact details */
+message AddressBook {
+ repeated Person person = 1;
+
+ extensions 1000 to max;
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/addressbook.txt
@@ -1,1 +1,23 @@
+person {
+ name: "John Doe"
+ id: 2051
+ email: "john.doe@gmail.com"
+ phone {
+ number: "1231231212"
+ type: HOME
+ }
+ phone {
+ number: "55512321312"
+ type: MOBILE
+ }
+}
+person {
+ name: "Iván Montes"
+ id: 23
+ email: "drslump@pollinimini.net"
+ phone {
+ number: "3493123123"
+ type: WORK
+ }
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated-int32.bin
@@ -1,1 +1,1 @@
-
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated-int32.txt
@@ -1,1 +1,4 @@
+int: 1
+int: 2
+int: 3
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated-nested.bin
@@ -1,1 +1,1 @@
-
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated-nested.txt
@@ -1,1 +1,10 @@
+nested {
+ id: 1
+}
+nested {
+ id: 2
+}
+nested {
+ id: 3
+}
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated-string.bin
@@ -1,1 +1,4 @@
+one
+two
+three
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated-string.txt
@@ -1,1 +1,4 @@
+string: "one"
+string: "two"
+string: "three"
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated.php
@@ -1,1 +1,302 @@
-
+<?php
+// DO NOT EDIT! Generated by Protobuf for PHP protoc plugin @package_version@
+// Source: repeated.proto
+// Date: 2011-04-12 14:07:42
+
+namespace tests {
+
+ class Repeated extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor('\tests\Repeated');
+
+ // repeated string = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "string";
+ $f->type = 9;
+ $f->rule = 3;
+ $descriptor->addField($f);
+
+ // repeated int = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "int";
+ $f->type = 5;
+ $f->rule = 3;
+ $descriptor->addField($f);
+
+ // repeated .tests.Repeated.Nested nested = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "nested";
+ $f->type = 11;
+ $f->rule = 3;
+ $f->reference = '\tests\Repeated\Nested';
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ return $descriptor;
+ }
+
+ /** @var string[] */
+ public $string = array();
+
+ /** @var int[] */
+ public $int = array();
+
+ /** @var \tests\Repeated\Nested[] */
+ public $nested = array();
+
+
+ /**
+ * Check if <string> has a value
+ *
+ * @return boolean
+ */
+ public function hasString(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <string> value
+ *
+ * @return \tests\Repeated
+ */
+ public function clearString(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <string> value
+ *
+ * @param int $idx
+ * @return string
+ */
+ public function getString($idx = NULL){
+ return $this->_get(1, $idx);
+ }
+
+ /**
+ * Set <string> value
+ *
+ * @param string $value
+ * @return \tests\Repeated
+ */
+ public function setString( $value, $idx = NULL){
+ return $this->_set(1, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <string>
+ *
+ * @return string[]
+ */
+ public function getStringList(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Add a new element to <string>
+ *
+ * @param string $value
+ * @return \tests\Repeated
+ */
+ public function addString( $value){
+ return $this->_add(1, $value);
+ }
+
+ /**
+ * Check if <int> has a value
+ *
+ * @return boolean
+ */
+ public function hasInt(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <int> value
+ *
+ * @return \tests\Repeated
+ */
+ public function clearInt(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <int> value
+ *
+ * @param int $idx
+ * @return int
+ */
+ public function getInt($idx = NULL){
+ return $this->_get(2, $idx);
+ }
+
+ /**
+ * Set <int> value
+ *
+ * @param int $value
+ * @return \tests\Repeated
+ */
+ public function setInt( $value, $idx = NULL){
+ return $this->_set(2, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <int>
+ *
+ * @return int[]
+ */
+ public function getIntList(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Add a new element to <int>
+ *
+ * @param int $value
+ * @return \tests\Repeated
+ */
+ public function addInt( $value){
+ return $this->_add(2, $value);
+ }
+
+ /**
+ * Check if <nested> has a value
+ *
+ * @return boolean
+ */
+ public function hasNested(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <nested> value
+ *
+ * @return \tests\Repeated
+ */
+ public function clearNested(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <nested> value
+ *
+ * @param int $idx
+ * @return \tests\Repeated\Nested
+ */
+ public function getNested($idx = NULL){
+ return $this->_get(3, $idx);
+ }
+
+ /**
+ * Set <nested> value
+ *
+ * @param \tests\Repeated\Nested $value
+ * @return \tests\Repeated
+ */
+ public function setNested(\tests\Repeated\Nested $value, $idx = NULL){
+ return $this->_set(3, $value, $idx);
+ }
+
+ /**
+ * Get all elements of <nested>
+ *
+ * @return \tests\Repeated\Nested[]
+ */
+ public function getNestedList(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Add a new element to <nested>
+ *
+ * @param \tests\Repeated\Nested $value
+ * @return \tests\Repeated
+ */
+ public function addNested(\tests\Repeated\Nested $value){
+ return $this->_add(3, $value);
+ }
+
+ }
+}
+
+namespace tests\Repeated {
+
+ class Nested extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor(\DrSlump\Protobuf\Descriptor $descriptor = NULL)
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor('\tests\Repeated\Nested');
+
+ // optional id = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "id";
+ $f->type = 5;
+ $f->rule = 1;
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ return $descriptor;
+ }
+
+ /** @var int */
+ public $id = null;
+
+
+ /**
+ * Check if <id> has a value
+ *
+ * @return boolean
+ */
+ public function hasId(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <id> value
+ *
+ * @return \tests\Repeated\Nested
+ */
+ public function clearId(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <id> value
+ *
+ * @return int
+ */
+ public function getId(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <id> value
+ *
+ * @param int $value
+ * @return \tests\Repeated\Nested
+ */
+ public function setId( $value){
+ return $this->_set(1, $value);
+ }
+
+ }
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/repeated.proto
@@ -1,1 +1,13 @@
+package tests;
+message Repeated {
+
+ message Nested {
+ optional int32 id = 1;
+ }
+
+ repeated string string = 1;
+ repeated int32 int = 2;
+ repeated Nested nested = 3;
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/simple.bin
@@ -1,1 +1,1 @@
-
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/simple.php
@@ -1,1 +1,789 @@
-
+<?php
+// DO NOT EDIT! Generated by Protobuf-PHP protoc plugin @package_version@
+// Source: simple.proto
+// Date: 2011-07-10 10:05:44
+
+// @@protoc_insertion_point(scope_file)
+
+namespace tests {
+
+ // @@protoc_insertion_point(scope_namespace)
+ // @@protoc_insertion_point(namespace_tests)
+
+ class Simple extends \DrSlump\Protobuf\Message {
+
+ /** @var \Closure[] */
+ protected static $__extensions = array();
+
+ public static function descriptor()
+ {
+ $descriptor = new \DrSlump\Protobuf\Descriptor('\tests\Simple');
+
+ // optional double = 1
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 1;
+ $f->name = "double";
+ $f->type = 1;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:double)
+ $descriptor->addField($f);
+
+ // optional float = 2
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 2;
+ $f->name = "float";
+ $f->type = 2;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:float)
+ $descriptor->addField($f);
+
+ // optional int64 = 3
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 3;
+ $f->name = "int64";
+ $f->type = 3;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:int64)
+ $descriptor->addField($f);
+
+ // optional uint64 = 4
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 4;
+ $f->name = "uint64";
+ $f->type = 4;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:uint64)
+ $descriptor->addField($f);
+
+ // optional int32 = 5
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 5;
+ $f->name = "int32";
+ $f->type = 5;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:int32)
+ $descriptor->addField($f);
+
+ // optional fixed64 = 6
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 6;
+ $f->name = "fixed64";
+ $f->type = 6;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:fixed64)
+ $descriptor->addField($f);
+
+ // optional fixed32 = 7
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 7;
+ $f->name = "fixed32";
+ $f->type = 7;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:fixed32)
+ $descriptor->addField($f);
+
+ // optional bool = 8
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 8;
+ $f->name = "bool";
+ $f->type = 8;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:bool)
+ $descriptor->addField($f);
+
+ // optional string = 9
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 9;
+ $f->name = "string";
+ $f->type = 9;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:string)
+ $descriptor->addField($f);
+
+ // optional bytes = 12
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 12;
+ $f->name = "bytes";
+ $f->type = 12;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:bytes)
+ $descriptor->addField($f);
+
+ // optional uint32 = 13
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 13;
+ $f->name = "uint32";
+ $f->type = 13;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:uint32)
+ $descriptor->addField($f);
+
+ // optional sfixed32 = 15
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 15;
+ $f->name = "sfixed32";
+ $f->type = 15;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:sfixed32)
+ $descriptor->addField($f);
+
+ // optional sfixed64 = 16
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 16;
+ $f->name = "sfixed64";
+ $f->type = 16;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:sfixed64)
+ $descriptor->addField($f);
+
+ // optional sint32 = 17
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 17;
+ $f->name = "sint32";
+ $f->type = 17;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:sint32)
+ $descriptor->addField($f);
+
+ // optional sint64 = 18
+ $f = new \DrSlump\Protobuf\Field();
+ $f->number = 18;
+ $f->name = "sint64";
+ $f->type = 18;
+ $f->rule = 1;
+ // @@protoc_insertion_point(scope_field)
+ // @@protoc_insertion_point(field_tests.Simple:sint64)
+ $descriptor->addField($f);
+
+ foreach (self::$__extensions as $cb) {
+ $descriptor->addField($cb(), true);
+ }
+
+ // @@protoc_insertion_point(scope_descriptor)
+ // @@protoc_insertion_point(descriptor_tests.Simple)
+
+ return $descriptor;
+ }
+
+ /** @var float */
+ public $double = null;
+
+ /** @var float */
+ public $float = null;
+
+ /** @var int */
+ public $int64 = null;
+
+ /** @var int */
+ public $uint64 = null;
+
+ /** @var int */
+ public $int32 = null;
+
+ /** @var int */
+ public $fixed64 = null;
+
+ /** @var int */
+ public $fixed32 = null;
+
+ /** @var boolean */
+ public $bool = null;
+
+ /** @var string */
+ public $string = null;
+
+ /** @var string */
+ public $bytes = null;
+
+ /** @var int */
+ public $uint32 = null;
+
+ /** @var int */
+ public $sfixed32 = null;
+
+ /** @var int */
+ public $sfixed64 = null;
+
+ /** @var int */
+ public $sint32 = null;
+
+ /** @var int */
+ public $sint64 = null;
+
+
+ /**
+ * Check if <double> has a value
+ *
+ * @return boolean
+ */
+ public function hasDouble(){
+ return $this->_has(1);
+ }
+
+ /**
+ * Clear <double> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearDouble(){
+ return $this->_clear(1);
+ }
+
+ /**
+ * Get <double> value
+ *
+ * @return float
+ */
+ public function getDouble(){
+ return $this->_get(1);
+ }
+
+ /**
+ * Set <double> value
+ *
+ * @param float $value
+ * @return \tests\Simple
+ */
+ public function setDouble( $value){
+ return $this->_set(1, $value);
+ }
+
+ /**
+ * Check if <float> has a value
+ *
+ * @return boolean
+ */
+ public function hasFloat(){
+ return $this->_has(2);
+ }
+
+ /**
+ * Clear <float> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearFloat(){
+ return $this->_clear(2);
+ }
+
+ /**
+ * Get <float> value
+ *
+ * @return float
+ */
+ public function getFloat(){
+ return $this->_get(2);
+ }
+
+ /**
+ * Set <float> value
+ *
+ * @param float $value
+ * @return \tests\Simple
+ */
+ public function setFloat( $value){
+ return $this->_set(2, $value);
+ }
+
+ /**
+ * Check if <int64> has a value
+ *
+ * @return boolean
+ */
+ public function hasInt64(){
+ return $this->_has(3);
+ }
+
+ /**
+ * Clear <int64> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearInt64(){
+ return $this->_clear(3);
+ }
+
+ /**
+ * Get <int64> value
+ *
+ * @return int
+ */
+ public function getInt64(){
+ return $this->_get(3);
+ }
+
+ /**
+ * Set <int64> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setInt64( $value){
+ return $this->_set(3, $value);
+ }
+
+ /**
+ * Check if <uint64> has a value
+ *
+ * @return boolean
+ */
+ public function hasUint64(){
+ return $this->_has(4);
+ }
+
+ /**
+ * Clear <uint64> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearUint64(){
+ return $this->_clear(4);
+ }
+
+ /**
+ * Get <uint64> value
+ *
+ * @return int
+ */
+ public function getUint64(){
+ return $this->_get(4);
+ }
+
+ /**
+ * Set <uint64> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setUint64( $value){
+ return $this->_set(4, $value);
+ }
+
+ /**
+ * Check if <int32> has a value
+ *
+ * @return boolean
+ */
+ public function hasInt32(){
+ return $this->_has(5);
+ }
+
+ /**
+ * Clear <int32> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearInt32(){
+ return $this->_clear(5);
+ }
+
+ /**
+ * Get <int32> value
+ *
+ * @return int
+ */
+ public function getInt32(){
+ return $this->_get(5);
+ }
+
+ /**
+ * Set <int32> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setInt32( $value){
+ return $this->_set(5, $value);
+ }
+
+ /**
+ * Check if <fixed64> has a value
+ *
+ * @return boolean
+ */
+ public function hasFixed64(){
+ return $this->_has(6);
+ }
+
+ /**
+ * Clear <fixed64> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearFixed64(){
+ return $this->_clear(6);
+ }
+
+ /**
+ * Get <fixed64> value
+ *
+ * @return int
+ */
+ public function getFixed64(){
+ return $this->_get(6);
+ }
+
+ /**
+ * Set <fixed64> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setFixed64( $value){
+ return $this->_set(6, $value);
+ }
+
+ /**
+ * Check if <fixed32> has a value
+ *
+ * @return boolean
+ */
+ public function hasFixed32(){
+ return $this->_has(7);
+ }
+
+ /**
+ * Clear <fixed32> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearFixed32(){
+ return $this->_clear(7);
+ }
+
+ /**
+ * Get <fixed32> value
+ *
+ * @return int
+ */
+ public function getFixed32(){
+ return $this->_get(7);
+ }
+
+ /**
+ * Set <fixed32> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setFixed32( $value){
+ return $this->_set(7, $value);
+ }
+
+ /**
+ * Check if <bool> has a value
+ *
+ * @return boolean
+ */
+ public function hasBool(){
+ return $this->_has(8);
+ }
+
+ /**
+ * Clear <bool> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearBool(){
+ return $this->_clear(8);
+ }
+
+ /**
+ * Get <bool> value
+ *
+ * @return boolean
+ */
+ public function getBool(){
+ return $this->_get(8);
+ }
+
+ /**
+ * Set <bool> value
+ *
+ * @param boolean $value
+ * @return \tests\Simple
+ */
+ public function setBool( $value){
+ return $this->_set(8, $value);
+ }
+
+ /**
+ * Check if <string> has a value
+ *
+ * @return boolean
+ */
+ public function hasString(){
+ return $this->_has(9);
+ }
+
+ /**
+ * Clear <string> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearString(){
+ return $this->_clear(9);
+ }
+
+ /**
+ * Get <string> value
+ *
+ * @return string
+ */
+ public function getString(){
+ return $this->_get(9);
+ }
+
+ /**
+ * Set <string> value
+ *
+ * @param string $value
+ * @return \tests\Simple
+ */
+ public function setString( $value){
+ return $this->_set(9, $value);
+ }
+
+ /**
+ * Check if <bytes> has a value
+ *
+ * @return boolean
+ */
+ public function hasBytes(){
+ return $this->_has(12);
+ }
+
+ /**
+ * Clear <bytes> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearBytes(){
+ return $this->_clear(12);
+ }
+
+ /**
+ * Get <bytes> value
+ *
+ * @return string
+ */
+ public function getBytes(){
+ return $this->_get(12);
+ }
+
+ /**
+ * Set <bytes> value
+ *
+ * @param string $value
+ * @return \tests\Simple
+ */
+ public function setBytes( $value){
+ return $this->_set(12, $value);
+ }
+
+ /**
+ * Check if <uint32> has a value
+ *
+ * @return boolean
+ */
+ public function hasUint32(){
+ return $this->_has(13);
+ }
+
+ /**
+ * Clear <uint32> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearUint32(){
+ return $this->_clear(13);
+ }
+
+ /**
+ * Get <uint32> value
+ *
+ * @return int
+ */
+ public function getUint32(){
+ return $this->_get(13);
+ }
+
+ /**
+ * Set <uint32> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setUint32( $value){
+ return $this->_set(13, $value);
+ }
+
+ /**
+ * Check if <sfixed32> has a value
+ *
+ * @return boolean
+ */
+ public function hasSfixed32(){
+ return $this->_has(15);
+ }
+
+ /**
+ * Clear <sfixed32> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearSfixed32(){
+ return $this->_clear(15);
+ }
+
+ /**
+ * Get <sfixed32> value
+ *
+ * @return int
+ */
+ public function getSfixed32(){
+ return $this->_get(15);
+ }
+
+ /**
+ * Set <sfixed32> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setSfixed32( $value){
+ return $this->_set(15, $value);
+ }
+
+ /**
+ * Check if <sfixed64> has a value
+ *
+ * @return boolean
+ */
+ public function hasSfixed64(){
+ return $this->_has(16);
+ }
+
+ /**
+ * Clear <sfixed64> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearSfixed64(){
+ return $this->_clear(16);
+ }
+
+ /**
+ * Get <sfixed64> value
+ *
+ * @return int
+ */
+ public function getSfixed64(){
+ return $this->_get(16);
+ }
+
+ /**
+ * Set <sfixed64> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setSfixed64( $value){
+ return $this->_set(16, $value);
+ }
+
+ /**
+ * Check if <sint32> has a value
+ *
+ * @return boolean
+ */
+ public function hasSint32(){
+ return $this->_has(17);
+ }
+
+ /**
+ * Clear <sint32> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearSint32(){
+ return $this->_clear(17);
+ }
+
+ /**
+ * Get <sint32> value
+ *
+ * @return int
+ */
+ public function getSint32(){
+ return $this->_get(17);
+ }
+
+ /**
+ * Set <sint32> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setSint32( $value){
+ return $this->_set(17, $value);
+ }
+
+ /**
+ * Check if <sint64> has a value
+ *
+ * @return boolean
+ */
+ public function hasSint64(){
+ return $this->_has(18);
+ }
+
+ /**
+ * Clear <sint64> value
+ *
+ * @return \tests\Simple
+ */
+ public function clearSint64(){
+ return $this->_clear(18);
+ }
+
+ /**
+ * Get <sint64> value
+ *
+ * @return int
+ */
+ public function getSint64(){
+ return $this->_get(18);
+ }
+
+ /**
+ * Set <sint64> value
+ *
+ * @param int $value
+ * @return \tests\Simple
+ */
+ public function setSint64( $value){
+ return $this->_set(18, $value);
+ }
+
+
+ // @@protoc_insertion_point(scope_class)
+ // @@protoc_insertion_point(class_tests.Simple)
+ }
+}
+
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/simple.proto
@@ -1,1 +1,20 @@
+package tests;
+message Simple {
+ optional double double = 1;
+ optional float float = 2;
+ optional int64 int64 = 3;
+ optional uint64 uint64 = 4;
+ optional int32 int32 = 5;
+ optional fixed64 fixed64 = 6;
+ optional fixed32 fixed32 = 7;
+ optional bool bool = 8;
+ optional string string = 9;
+ optional bytes bytes = 12;
+ optional uint32 uint32 = 13;
+ optional sfixed32 sfixed32 = 15;
+ optional sfixed64 sfixed64 = 16;
+ optional sint32 sint32 = 17;
+ optional sint64 sint64 = 18;
+}
+
--- /dev/null
+++ b/lib/Protobuf-PHP/tests/protos/simple.txt
@@ -1,1 +1,16 @@
+double: 123456789.12345
+float: 12345.123
+int64: -123456789123456789
+uint64: 123456789123456789
+int32: -123456789
+fixed64: 123456789123456789
+fixed32: 123456789
+bool: 1
+string: "foo"
+bytes: "bar"
+uint32: 123456789
+sfixed32: -123456789
+sfixed64: -123456789123456789
+sint32: -123456789
+sint64: -123456789123456789
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID.php
@@ -1,1 +1,564 @@
-
+<?php
+
+/**
+ * This is the PHP OpenID library by JanRain, Inc.
+ *
+ * This module contains core utility functionality used by the
+ * library. See Consumer.php and Server.php for the consumer and
+ * server implementations.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * The library version string
+ */
+define('Auth_OpenID_VERSION', '2.2.2');
+
+/**
+ * Require the fetcher code.
+ */
+require_once "Auth/Yadis/PlainHTTPFetcher.php";
+require_once "Auth/Yadis/ParanoidHTTPFetcher.php";
+require_once "Auth/OpenID/BigMath.php";
+require_once "Auth/OpenID/URINorm.php";
+
+/**
+ * Status code returned by the server when the only option is to show
+ * an error page, since we do not have enough information to redirect
+ * back to the consumer. The associated value is an error message that
+ * should be displayed on an HTML error page.
+ *
+ * @see Auth_OpenID_Server
+ */
+define('Auth_OpenID_LOCAL_ERROR', 'local_error');
+
+/**
+ * Status code returned when there is an error to return in key-value
+ * form to the consumer. The caller should return a 400 Bad Request
+ * response with content-type text/plain and the value as the body.
+ *
+ * @see Auth_OpenID_Server
+ */
+define('Auth_OpenID_REMOTE_ERROR', 'remote_error');
+
+/**
+ * Status code returned when there is a key-value form OK response to
+ * the consumer. The value associated with this code is the
+ * response. The caller should return a 200 OK response with
+ * content-type text/plain and the value as the body.
+ *
+ * @see Auth_OpenID_Server
+ */
+define('Auth_OpenID_REMOTE_OK', 'remote_ok');
+
+/**
+ * Status code returned when there is a redirect back to the
+ * consumer. The value is the URL to redirect back to. The caller
+ * should return a 302 Found redirect with a Location: header
+ * containing the URL.
+ *
+ * @see Auth_OpenID_Server
+ */
+define('Auth_OpenID_REDIRECT', 'redirect');
+
+/**
+ * Status code returned when the caller needs to authenticate the
+ * user. The associated value is a {@link Auth_OpenID_ServerRequest}
+ * object that can be used to complete the authentication. If the user
+ * has taken some authentication action, use the retry() method of the
+ * {@link Auth_OpenID_ServerRequest} object to complete the request.
+ *
+ * @see Auth_OpenID_Server
+ */
+define('Auth_OpenID_DO_AUTH', 'do_auth');
+
+/**
+ * Status code returned when there were no OpenID arguments
+ * passed. This code indicates that the caller should return a 200 OK
+ * response and display an HTML page that says that this is an OpenID
+ * server endpoint.
+ *
+ * @see Auth_OpenID_Server
+ */
+define('Auth_OpenID_DO_ABOUT', 'do_about');
+
+/**
+ * Defines for regexes and format checking.
+ */
+define('Auth_OpenID_letters',
+ "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ");
+
+define('Auth_OpenID_digits',
+ "0123456789");
+
+define('Auth_OpenID_punct',
+ "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~");
+
+Auth_OpenID_include_init();
+
+/**
+ * The OpenID utility function class.
+ *
+ * @package OpenID
+ * @access private
+ */
+class Auth_OpenID {
+
+ /**
+ * Return true if $thing is an Auth_OpenID_FailureResponse object;
+ * false if not.
+ *
+ * @access private
+ */
+ static function isFailure($thing)
+ {
+ return is_a($thing, 'Auth_OpenID_FailureResponse');
+ }
+
+ /**
+ * Gets the query data from the server environment based on the
+ * request method used. If GET was used, this looks at
+ * $_SERVER['QUERY_STRING'] directly. If POST was used, this
+ * fetches data from the special php://input file stream.
+ *
+ * Returns an associative array of the query arguments.
+ *
+ * Skips invalid key/value pairs (i.e. keys with no '=value'
+ * portion).
+ *
+ * Returns an empty array if neither GET nor POST was used, or if
+ * POST was used but php://input cannot be opened.
+ *
+ * See background:
+ * http://lists.openidenabled.com/pipermail/dev/2007-March/000395.html
+ *
+ * @access private
+ */
+ static function getQuery($query_str=null)
+ {
+ $data = array();
+
+ if ($query_str !== null) {
+ $data = Auth_OpenID::params_from_string($query_str);
+ } else if (!array_key_exists('REQUEST_METHOD', $_SERVER)) {
+ // Do nothing.
+ } else {
+ // XXX HACK FIXME HORRIBLE.
+ //
+ // POSTing to a URL with query parameters is acceptable, but
+ // we don't have a clean way to distinguish those parameters
+ // when we need to do things like return_to verification
+ // which only want to look at one kind of parameter. We're
+ // going to emulate the behavior of some other environments
+ // by defaulting to GET and overwriting with POST if POST
+ // data is available.
+ $data = Auth_OpenID::params_from_string($_SERVER['QUERY_STRING']);
+
+ if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+ $str = file_get_contents('php://input');
+
+ if ($str === false) {
+ $post = array();
+ } else {
+ $post = Auth_OpenID::params_from_string($str);
+ }
+
+ $data = array_merge($data, $post);
+ }
+ }
+
+ return $data;
+ }
+
+ static function params_from_string($str)
+ {
+ $chunks = explode("&", $str);
+
+ $data = array();
+ foreach ($chunks as $chunk) {
+ $parts = explode("=", $chunk, 2);
+
+ if (count($parts) != 2) {
+ continue;
+ }
+
+ list($k, $v) = $parts;
+ $data[urldecode($k)] = urldecode($v);
+ }
+
+ return $data;
+ }
+
+ /**
+ * Create dir_name as a directory if it does not exist. If it
+ * exists, make sure that it is, in fact, a directory. Returns
+ * true if the operation succeeded; false if not.
+ *
+ * @access private
+ */
+ static function ensureDir($dir_name)
+ {
+ if (is_dir($dir_name) || @mkdir($dir_name)) {
+ return true;
+ } else {
+ $parent_dir = dirname($dir_name);
+
+ // Terminal case; there is no parent directory to create.
+ if ($parent_dir == $dir_name) {
+ return true;
+ }
+
+ return (Auth_OpenID::ensureDir($parent_dir) && @mkdir($dir_name));
+ }
+ }
+
+ /**
+ * Adds a string prefix to all values of an array. Returns a new
+ * array containing the prefixed values.
+ *
+ * @access private
+ */
+ static function addPrefix($values, $prefix)
+ {
+ $new_values = array();
+ foreach ($values as $s) {
+ $new_values[] = $prefix . $s;
+ }
+ return $new_values;
+ }
+
+ /**
+ * Convenience function for getting array values. Given an array
+ * $arr and a key $key, get the corresponding value from the array
+ * or return $default if the key is absent.
+ *
+ * @access private
+ */
+ static function arrayGet($arr, $key, $fallback = null)
+ {
+ if (is_array($arr)) {
+ if (array_key_exists($key, $arr)) {
+ return $arr[$key];
+ } else {
+ return $fallback;
+ }
+ } else {
+ trigger_error("Auth_OpenID::arrayGet (key = ".$key.") expected " .
+ "array as first parameter, got " .
+ gettype($arr), E_USER_WARNING);
+
+ return false;
+ }
+ }
+
+ /**
+ * Replacement for PHP's broken parse_str.
+ */
+ static function parse_str($query)
+ {
+ if ($query === null) {
+ return null;
+ }
+
+ $parts = explode('&', $query);
+
+ $new_parts = array();
+ for ($i = 0; $i < count($parts); $i++) {
+ $pair = explode('=', $parts[$i]);
+
+ if (count($pair) != 2) {
+ continue;
+ }
+
+ list($key, $value) = $pair;
+ $new_parts[urldecode($key)] = urldecode($value);
+ }
+
+ return $new_parts;
+ }
+
+ /**
+ * Implements the PHP 5 'http_build_query' functionality.
+ *
+ * @access private
+ * @param array $data Either an array key/value pairs or an array
+ * of arrays, each of which holding two values: a key and a value,
+ * sequentially.
+ * @return string $result The result of url-encoding the key/value
+ * pairs from $data into a URL query string
+ * (e.g. "username=bob&id=56").
+ */
+ static function httpBuildQuery($data)
+ {
+ $pairs = array();
+ foreach ($data as $key => $value) {
+ if (is_array($value)) {
+ $pairs[] = urlencode($value[0])."=".urlencode($value[1]);
+ } else {
+ $pairs[] = urlencode($key)."=".urlencode($value);
+ }
+ }
+ return implode("&", $pairs);
+ }
+
+ /**
+ * "Appends" query arguments onto a URL. The URL may or may not
+ * already have arguments (following a question mark).
+ *
+ * @access private
+ * @param string $url A URL, which may or may not already have
+ * arguments.
+ * @param array $args Either an array key/value pairs or an array of
+ * arrays, each of which holding two values: a key and a value,
+ * sequentially. If $args is an ordinary key/value array, the
+ * parameters will be added to the URL in sorted alphabetical order;
+ * if $args is an array of arrays, their order will be preserved.
+ * @return string $url The original URL with the new parameters added.
+ *
+ */
+ static function appendArgs($url, $args)
+ {
+ if (count($args) == 0) {
+ return $url;
+ }
+
+ // Non-empty array; if it is an array of arrays, use
+ // multisort; otherwise use sort.
+ if (array_key_exists(0, $args) &&
+ is_array($args[0])) {
+ // Do nothing here.
+ } else {
+ $keys = array_keys($args);
+ sort($keys);
+ $new_args = array();
+ foreach ($keys as $key) {
+ $new_args[] = array($key, $args[$key]);
+ }
+ $args = $new_args;
+ }
+
+ $sep = '?';
+ if (strpos($url, '?') !== false) {
+ $sep = '&';
+ }
+
+ return $url . $sep . Auth_OpenID::httpBuildQuery($args);
+ }
+
+ /**
+ * Implements python's urlunparse, which is not available in PHP.
+ * Given the specified components of a URL, this function rebuilds
+ * and returns the URL.
+ *
+ * @access private
+ * @param string $scheme The scheme (e.g. 'http'). Defaults to 'http'.
+ * @param string $host The host. Required.
+ * @param string $port The port.
+ * @param string $path The path.
+ * @param string $query The query.
+ * @param string $fragment The fragment.
+ * @return string $url The URL resulting from assembling the
+ * specified components.
+ */
+ static function urlunparse($scheme, $host, $port = null, $path = '/',
+ $query = '', $fragment = '')
+ {
+
+ if (!$scheme) {
+ $scheme = 'http';
+ }
+
+ if (!$host) {
+ return false;
+ }
+
+ if (!$path) {
+ $path = '';
+ }
+
+ $result = $scheme . "://" . $host;
+
+ if ($port) {
+ $result .= ":" . $port;
+ }
+
+ $result .= $path;
+
+ if ($query) {
+ $result .= "?" . $query;
+ }
+
+ if ($fragment) {
+ $result .= "#" . $fragment;
+ }
+
+ return $result;
+ }
+
+ /**
+ * Given a URL, this "normalizes" it by adding a trailing slash
+ * and / or a leading http:// scheme where necessary. Returns
+ * null if the original URL is malformed and cannot be normalized.
+ *
+ * @access private
+ * @param string $url The URL to be normalized.
+ * @return mixed $new_url The URL after normalization, or null if
+ * $url was malformed.
+ */
+ static function normalizeUrl($url)
+ {
+ @$parsed = parse_url($url);
+
+ if (!$parsed) {
+ return null;
+ }
+
+ if (isset($parsed['scheme']) &&
+ isset($parsed['host'])) {
+ $scheme = strtolower($parsed['scheme']);
+ if (!in_array($scheme, array('http', 'https'))) {
+ return null;
+ }
+ } else {
+ $url = 'http://' . $url;
+ }
+
+ $normalized = Auth_OpenID_urinorm($url);
+ if ($normalized === null) {
+ return null;
+ }
+ list($defragged, $frag) = Auth_OpenID::urldefrag($normalized);
+ return $defragged;
+ }
+
+ /**
+ * Replacement (wrapper) for PHP's intval() because it's broken.
+ *
+ * @access private
+ */
+ static function intval($value)
+ {
+ $re = "/^\\d+$/";
+
+ if (!preg_match($re, $value)) {
+ return false;
+ }
+
+ return intval($value);
+ }
+
+ /**
+ * Count the number of bytes in a string independently of
+ * multibyte support conditions.
+ *
+ * @param string $str The string of bytes to count.
+ * @return int The number of bytes in $str.
+ */
+ static function bytes($str)
+ {
+ return strlen(bin2hex($str)) / 2;
+ }
+
+ /**
+ * Get the bytes in a string independently of multibyte support
+ * conditions.
+ */
+ static function toBytes($str)
+ {
+ $hex = bin2hex($str);
+
+ if (!$hex) {
+ return array();
+ }
+
+ $b = array();
+ for ($i = 0; $i < strlen($hex); $i += 2) {
+ $b[] = chr(base_convert(substr($hex, $i, 2), 16, 10));
+ }
+
+ return $b;
+ }
+
+ static function urldefrag($url)
+ {
+ $parts = explode("#", $url, 2);
+
+ if (count($parts) == 1) {
+ return array($parts[0], "");
+ } else {
+ return $parts;
+ }
+ }
+
+ static function filter($callback, &$sequence)
+ {
+ $result = array();
+
+ foreach ($sequence as $item) {
+ if (call_user_func_array($callback, array($item))) {
+ $result[] = $item;
+ }
+ }
+
+ return $result;
+ }
+
+ static function update(&$dest, &$src)
+ {
+ foreach ($src as $k => $v) {
+ $dest[$k] = $v;
+ }
+ }
+
+ /**
+ * Wrap PHP's standard error_log functionality. Use this to
+ * perform all logging. It will interpolate any additional
+ * arguments into the format string before logging.
+ *
+ * @param string $format_string The sprintf format for the message
+ */
+ static function log($format_string)
+ {
+ $args = func_get_args();
+ $message = call_user_func_array('sprintf', $args);
+ error_log($message);
+ }
+
+ static function autoSubmitHTML($form, $title="OpenId transaction in progress")
+ {
+ return("<html>".
+ "<head><title>".
+ $title .
+ "</title></head>".
+ "<body onload='document.forms[0].submit();'>".
+ $form .
+ "<script>".
+ "var elements = document.forms[0].elements;".
+ "for (var i = 0; i < elements.length; i++) {".
+ " elements[i].style.display = \"none\";".
+ "}".
+ "</script>".
+ "</body>".
+ "</html>");
+ }
+}
+
+/*
+ * Function to run when this file is included.
+ * Abstracted to a function to make life easier
+ * for some PHP optimizers.
+ */
+function Auth_OpenID_include_init() {
+ if (Auth_OpenID_getMathLib() === null) {
+ Auth_OpenID_setNoMathSupport();
+ }
+}
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/AX.php
@@ -1,1 +1,1023 @@
-
+<?php
+
+/**
+ * Implements the OpenID attribute exchange specification, version 1.0
+ * as of svn revision 370 from openid.net svn.
+ *
+ * @package OpenID
+ */
+
+/**
+ * Require utility classes and functions for the consumer.
+ */
+require_once "Auth/OpenID/Extension.php";
+require_once "Auth/OpenID/Message.php";
+require_once "Auth/OpenID/TrustRoot.php";
+
+define('Auth_OpenID_AX_NS_URI',
+ 'http://openid.net/srv/ax/1.0');
+
+// Use this as the 'count' value for an attribute in a FetchRequest to
+// ask for as many values as the OP can provide.
+define('Auth_OpenID_AX_UNLIMITED_VALUES', 'unlimited');
+
+// Minimum supported alias length in characters. Here for
+// completeness.
+define('Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH', 32);
+
+/**
+ * AX utility class.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX {
+ /**
+ * @param mixed $thing Any object which may be an
+ * Auth_OpenID_AX_Error object.
+ *
+ * @return bool true if $thing is an Auth_OpenID_AX_Error; false
+ * if not.
+ */
+ static function isError($thing)
+ {
+ return is_a($thing, 'Auth_OpenID_AX_Error');
+ }
+}
+
+/**
+ * Check an alias for invalid characters; raise AXError if any are
+ * found. Return None if the alias is valid.
+ */
+function Auth_OpenID_AX_checkAlias($alias)
+{
+ if (strpos($alias, ',') !== false) {
+ return new Auth_OpenID_AX_Error(sprintf(
+ "Alias %s must not contain comma", $alias));
+ }
+ if (strpos($alias, '.') !== false) {
+ return new Auth_OpenID_AX_Error(sprintf(
+ "Alias %s must not contain period", $alias));
+ }
+
+ return true;
+}
+
+/**
+ * Results from data that does not meet the attribute exchange 1.0
+ * specification
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_Error {
+ function Auth_OpenID_AX_Error($message=null)
+ {
+ $this->message = $message;
+ }
+}
+
+/**
+ * Abstract class containing common code for attribute exchange
+ * messages.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_Message extends Auth_OpenID_Extension {
+ /**
+ * ns_alias: The preferred namespace alias for attribute exchange
+ * messages
+ */
+ var $ns_alias = 'ax';
+
+ /**
+ * mode: The type of this attribute exchange message. This must be
+ * overridden in subclasses.
+ */
+ var $mode = null;
+
+ var $ns_uri = Auth_OpenID_AX_NS_URI;
+
+ /**
+ * Return Auth_OpenID_AX_Error if the mode in the attribute
+ * exchange arguments does not match what is expected for this
+ * class; true otherwise.
+ *
+ * @access private
+ */
+ function _checkMode($ax_args)
+ {
+ $mode = Auth_OpenID::arrayGet($ax_args, 'mode');
+ if ($mode != $this->mode) {
+ return new Auth_OpenID_AX_Error(
+ sprintf(
+ "Expected mode '%s'; got '%s'",
+ $this->mode, $mode));
+ }
+
+ return true;
+ }
+
+ /**
+ * Return a set of attribute exchange arguments containing the
+ * basic information that must be in every attribute exchange
+ * message.
+ *
+ * @access private
+ */
+ function _newArgs()
+ {
+ return array('mode' => $this->mode);
+ }
+}
+
+/**
+ * Represents a single attribute in an attribute exchange
+ * request. This should be added to an AXRequest object in order to
+ * request the attribute.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_AttrInfo {
+ /**
+ * Construct an attribute information object. Do not call this
+ * directly; call make(...) instead.
+ *
+ * @param string $type_uri The type URI for this attribute.
+ *
+ * @param int $count The number of values of this type to request.
+ *
+ * @param bool $required Whether the attribute will be marked as
+ * required in the request.
+ *
+ * @param string $alias The name that should be given to this
+ * attribute in the request.
+ */
+ function Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,
+ $alias)
+ {
+ /**
+ * required: Whether the attribute will be marked as required
+ * when presented to the subject of the attribute exchange
+ * request.
+ */
+ $this->required = $required;
+
+ /**
+ * count: How many values of this type to request from the
+ * subject. Defaults to one.
+ */
+ $this->count = $count;
+
+ /**
+ * type_uri: The identifier that determines what the attribute
+ * represents and how it is serialized. For example, one type
+ * URI representing dates could represent a Unix timestamp in
+ * base 10 and another could represent a human-readable
+ * string.
+ */
+ $this->type_uri = $type_uri;
+
+ /**
+ * alias: The name that should be given to this attribute in
+ * the request. If it is not supplied, a generic name will be
+ * assigned. For example, if you want to call a Unix timestamp
+ * value 'tstamp', set its alias to that value. If two
+ * attributes in the same message request to use the same
+ * alias, the request will fail to be generated.
+ */
+ $this->alias = $alias;
+ }
+
+ /**
+ * Construct an attribute information object. For parameter
+ * details, see the constructor.
+ */
+ static function make($type_uri, $count=1, $required=false,
+ $alias=null)
+ {
+ if ($alias !== null) {
+ $result = Auth_OpenID_AX_checkAlias($alias);
+
+ if (Auth_OpenID_AX::isError($result)) {
+ return $result;
+ }
+ }
+
+ return new Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,
+ $alias);
+ }
+
+ /**
+ * When processing a request for this attribute, the OP should
+ * call this method to determine whether all available attribute
+ * values were requested. If self.count == UNLIMITED_VALUES, this
+ * returns True. Otherwise this returns False, in which case
+ * self.count is an integer.
+ */
+ function wantsUnlimitedValues()
+ {
+ return $this->count === Auth_OpenID_AX_UNLIMITED_VALUES;
+ }
+}
+
+/**
+ * Given a namespace mapping and a string containing a comma-separated
+ * list of namespace aliases, return a list of type URIs that
+ * correspond to those aliases.
+ *
+ * @param $namespace_map The mapping from namespace URI to alias
+ * @param $alias_list_s The string containing the comma-separated
+ * list of aliases. May also be None for convenience.
+ *
+ * @return $seq The list of namespace URIs that corresponds to the
+ * supplied list of aliases. If the string was zero-length or None, an
+ * empty list will be returned.
+ *
+ * return null If an alias is present in the list of aliases but
+ * is not present in the namespace map.
+ */
+function Auth_OpenID_AX_toTypeURIs($namespace_map, $alias_list_s)
+{
+ $uris = array();
+
+ if ($alias_list_s) {
+ foreach (explode(',', $alias_list_s) as $alias) {
+ $type_uri = $namespace_map->getNamespaceURI($alias);
+ if ($type_uri === null) {
+ // raise KeyError(
+ // 'No type is defined for attribute name %r' % (alias,))
+ return new Auth_OpenID_AX_Error(
+ sprintf('No type is defined for attribute name %s',
+ $alias)
+ );
+ } else {
+ $uris[] = $type_uri;
+ }
+ }
+ }
+
+ return $uris;
+}
+
+/**
+ * An attribute exchange 'fetch_request' message. This message is sent
+ * by a relying party when it wishes to obtain attributes about the
+ * subject of an OpenID authentication request.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_FetchRequest extends Auth_OpenID_AX_Message {
+
+ var $mode = 'fetch_request';
+
+ function Auth_OpenID_AX_FetchRequest($update_url=null)
+ {
+ /**
+ * requested_attributes: The attributes that have been
+ * requested thus far, indexed by the type URI.
+ */
+ $this->requested_attributes = array();
+
+ /**
+ * update_url: A URL that will accept responses for this
+ * attribute exchange request, even in the absence of the user
+ * who made this request.
+ */
+ $this->update_url = $update_url;
+ }
+
+ /**
+ * Add an attribute to this attribute exchange request.
+ *
+ * @param attribute: The attribute that is being requested
+ * @return true on success, false when the requested attribute is
+ * already present in this fetch request.
+ */
+ function add($attribute)
+ {
+ if ($this->contains($attribute->type_uri)) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("The attribute %s has already been requested",
+ $attribute->type_uri));
+ }
+
+ $this->requested_attributes[$attribute->type_uri] = $attribute;
+
+ return true;
+ }
+
+ /**
+ * Get the serialized form of this attribute fetch request.
+ *
+ * @returns Auth_OpenID_AX_FetchRequest The fetch request message parameters
+ */
+ function getExtensionArgs()
+ {
+ $aliases = new Auth_OpenID_NamespaceMap();
+
+ $required = array();
+ $if_available = array();
+
+ $ax_args = $this->_newArgs();
+
+ foreach ($this->requested_attributes as $type_uri => $attribute) {
+ if ($attribute->alias === null) {
+ $alias = $aliases->add($type_uri);
+ } else {
+ $alias = $aliases->addAlias($type_uri, $attribute->alias);
+
+ if ($alias === null) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Could not add alias %s for URI %s",
+ $attribute->alias, $type_uri
+ ));
+ }
+ }
+
+ if ($attribute->required) {
+ $required[] = $alias;
+ } else {
+ $if_available[] = $alias;
+ }
+
+ if ($attribute->count != 1) {
+ $ax_args['count.' . $alias] = strval($attribute->count);
+ }
+
+ $ax_args['type.' . $alias] = $type_uri;
+ }
+
+ if ($required) {
+ $ax_args['required'] = implode(',', $required);
+ }
+
+ if ($if_available) {
+ $ax_args['if_available'] = implode(',', $if_available);
+ }
+
+ return $ax_args;
+ }
+
+ /**
+ * Get the type URIs for all attributes that have been marked as
+ * required.
+ *
+ * @return A list of the type URIs for attributes that have been
+ * marked as required.
+ */
+ function getRequiredAttrs()
+ {
+ $required = array();
+ foreach ($this->requested_attributes as $type_uri => $attribute) {
+ if ($attribute->required) {
+ $required[] = $type_uri;
+ }
+ }
+
+ return $required;
+ }
+
+ /**
+ * Extract a FetchRequest from an OpenID message
+ *
+ * @param request: The OpenID request containing the attribute
+ * fetch request
+ *
+ * @returns mixed An Auth_OpenID_AX_Error or the
+ * Auth_OpenID_AX_FetchRequest extracted from the request message if
+ * successful
+ */
+ static function fromOpenIDRequest($request)
+ {
+ $m = $request->message;
+ $obj = new Auth_OpenID_AX_FetchRequest();
+ $ax_args = $m->getArgs($obj->ns_uri);
+
+ $result = $obj->parseExtensionArgs($ax_args);
+
+ if (Auth_OpenID_AX::isError($result)) {
+ return $result;
+ }
+
+ if ($obj->update_url) {
+ // Update URL must match the openid.realm of the
+ // underlying OpenID 2 message.
+ $realm = $m->getArg(Auth_OpenID_OPENID_NS, 'realm',
+ $m->getArg(
+ Auth_OpenID_OPENID_NS,
+ 'return_to'));
+
+ if (!$realm) {
+ $obj = new Auth_OpenID_AX_Error(
+ sprintf("Cannot validate update_url %s " .
+ "against absent realm", $obj->update_url));
+ } else if (!Auth_OpenID_TrustRoot::match($realm,
+ $obj->update_url)) {
+ $obj = new Auth_OpenID_AX_Error(
+ sprintf("Update URL %s failed validation against realm %s",
+ $obj->update_url, $realm));
+ }
+ }
+
+ return $obj;
+ }
+
+ /**
+ * Given attribute exchange arguments, populate this FetchRequest.
+ *
+ * @return $result Auth_OpenID_AX_Error if the data to be parsed
+ * does not follow the attribute exchange specification. At least
+ * when 'if_available' or 'required' is not specified for a
+ * particular attribute type. Returns true otherwise.
+ */
+ function parseExtensionArgs($ax_args)
+ {
+ $result = $this->_checkMode($ax_args);
+ if (Auth_OpenID_AX::isError($result)) {
+ return $result;
+ }
+
+ $aliases = new Auth_OpenID_NamespaceMap();
+
+ foreach ($ax_args as $key => $value) {
+ if (strpos($key, 'type.') === 0) {
+ $alias = substr($key, 5);
+ $type_uri = $value;
+
+ $alias = $aliases->addAlias($type_uri, $alias);
+
+ if ($alias === null) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Could not add alias %s for URI %s",
+ $alias, $type_uri)
+ );
+ }
+
+ $count_s = Auth_OpenID::arrayGet($ax_args, 'count.' . $alias);
+ if ($count_s) {
+ $count = Auth_OpenID::intval($count_s);
+ if (($count === false) &&
+ ($count_s === Auth_OpenID_AX_UNLIMITED_VALUES)) {
+ $count = $count_s;
+ }
+ } else {
+ $count = 1;
+ }
+
+ if ($count === false) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Integer value expected for %s, got %s",
+ 'count.' . $alias, $count_s));
+ }
+
+ $attrinfo = Auth_OpenID_AX_AttrInfo::make($type_uri, $count,
+ false, $alias);
+
+ if (Auth_OpenID_AX::isError($attrinfo)) {
+ return $attrinfo;
+ }
+
+ $this->add($attrinfo);
+ }
+ }
+
+ $required = Auth_OpenID_AX_toTypeURIs($aliases,
+ Auth_OpenID::arrayGet($ax_args, 'required'));
+
+ foreach ($required as $type_uri) {
+ $attrib = $this->requested_attributes[$type_uri];
+ $attrib->required = true;
+ }
+
+ $if_available = Auth_OpenID_AX_toTypeURIs($aliases,
+ Auth_OpenID::arrayGet($ax_args, 'if_available'));
+
+ $all_type_uris = array_merge($required, $if_available);
+
+ foreach ($aliases->iterNamespaceURIs() as $type_uri) {
+ if (!in_array($type_uri, $all_type_uris)) {
+ return new Auth_OpenID_AX_Error(
+ sprintf('Type URI %s was in the request but not ' .
+ 'present in "required" or "if_available"',
+ $type_uri));
+
+ }
+ }
+
+ $this->update_url = Auth_OpenID::arrayGet($ax_args, 'update_url');
+
+ return true;
+ }
+
+ /**
+ * Iterate over the AttrInfo objects that are contained in this
+ * fetch_request.
+ */
+ function iterAttrs()
+ {
+ return array_values($this->requested_attributes);
+ }
+
+ function iterTypes()
+ {
+ return array_keys($this->requested_attributes);
+ }
+
+ /**
+ * Is the given type URI present in this fetch_request?
+ */
+ function contains($type_uri)
+ {
+ return in_array($type_uri, $this->iterTypes());
+ }
+}
+
+/**
+ * An abstract class that implements a message that has attribute keys
+ * and values. It contains the common code between fetch_response and
+ * store_request.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_KeyValueMessage extends Auth_OpenID_AX_Message {
+
+ function Auth_OpenID_AX_KeyValueMessage()
+ {
+ $this->data = array();
+ }
+
+ /**
+ * Add a single value for the given attribute type to the
+ * message. If there are already values specified for this type,
+ * this value will be sent in addition to the values already
+ * specified.
+ *
+ * @param type_uri: The URI for the attribute
+ * @param value: The value to add to the response to the relying
+ * party for this attribute
+ * @return null
+ */
+ function addValue($type_uri, $value)
+ {
+ if (!array_key_exists($type_uri, $this->data)) {
+ $this->data[$type_uri] = array();
+ }
+
+ $values =& $this->data[$type_uri];
+ $values[] = $value;
+ }
+
+ /**
+ * Set the values for the given attribute type. This replaces any
+ * values that have already been set for this attribute.
+ *
+ * @param type_uri: The URI for the attribute
+ * @param values: A list of values to send for this attribute.
+ */
+ function setValues($type_uri, &$values)
+ {
+ $this->data[$type_uri] =& $values;
+ }
+
+ /**
+ * Get the extension arguments for the key/value pairs contained
+ * in this message.
+ *
+ * @param aliases: An alias mapping. Set to None if you don't care
+ * about the aliases for this request.
+ *
+ * @access private
+ */
+ function _getExtensionKVArgs($aliases)
+ {
+ if ($aliases === null) {
+ $aliases = new Auth_OpenID_NamespaceMap();
+ }
+
+ $ax_args = array();
+
+ foreach ($this->data as $type_uri => $values) {
+ $alias = $aliases->add($type_uri);
+
+ $ax_args['type.' . $alias] = $type_uri;
+ $ax_args['count.' . $alias] = strval(count($values));
+
+ foreach ($values as $i => $value) {
+ $key = sprintf('value.%s.%d', $alias, $i + 1);
+ $ax_args[$key] = $value;
+ }
+ }
+
+ return $ax_args;
+ }
+
+ /**
+ * Parse attribute exchange key/value arguments into this object.
+ *
+ * @param ax_args: The attribute exchange fetch_response
+ * arguments, with namespacing removed.
+ *
+ * @return Auth_OpenID_AX_Error or true
+ */
+ function parseExtensionArgs($ax_args)
+ {
+ $result = $this->_checkMode($ax_args);
+ if (Auth_OpenID_AX::isError($result)) {
+ return $result;
+ }
+
+ $aliases = new Auth_OpenID_NamespaceMap();
+
+ foreach ($ax_args as $key => $value) {
+ if (strpos($key, 'type.') === 0) {
+ $type_uri = $value;
+ $alias = substr($key, 5);
+
+ $result = Auth_OpenID_AX_checkAlias($alias);
+
+ if (Auth_OpenID_AX::isError($result)) {
+ return $result;
+ }
+
+ $alias = $aliases->addAlias($type_uri, $alias);
+
+ if ($alias === null) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Could not add alias %s for URI %s",
+ $alias, $type_uri)
+ );
+ }
+ }
+ }
+
+ foreach ($aliases->iteritems() as $pair) {
+ list($type_uri, $alias) = $pair;
+
+ if (array_key_exists('count.' . $alias, $ax_args) && ($ax_args['count.' . $alias] !== Auth_OpenID_AX_UNLIMITED_VALUES)) {
+
+ $count_key = 'count.' . $alias;
+ $count_s = $ax_args[$count_key];
+
+ $count = Auth_OpenID::intval($count_s);
+
+ if ($count === false) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Integer value expected for %s, got %s",
+ 'count. %s' . $alias, $count_s,
+ Auth_OpenID_AX_UNLIMITED_VALUES)
+ );
+ }
+
+ $values = array();
+ for ($i = 1; $i < $count + 1; $i++) {
+ $value_key = sprintf('value.%s.%d', $alias, $i);
+
+ if (!array_key_exists($value_key, $ax_args)) {
+ return new Auth_OpenID_AX_Error(
+ sprintf(
+ "No value found for key %s",
+ $value_key));
+ }
+
+ $value = $ax_args[$value_key];
+ $values[] = $value;
+ }
+ } else {
+ $key = 'value.' . $alias;
+
+ if (!array_key_exists($key, $ax_args)) {
+ return new Auth_OpenID_AX_Error(
+ sprintf(
+ "No value found for key %s",
+ $key));
+ }
+
+ $value = $ax_args['value.' . $alias];
+
+ if ($value == '') {
+ $values = array();
+ } else {
+ $values = array($value);
+ }
+ }
+
+ $this->data[$type_uri] = $values;
+ }
+
+ return true;
+ }
+
+ /**
+ * Get a single value for an attribute. If no value was sent for
+ * this attribute, use the supplied default. If there is more than
+ * one value for this attribute, this method will fail.
+ *
+ * @param type_uri: The URI for the attribute
+ * @param default: The value to return if the attribute was not
+ * sent in the fetch_response.
+ *
+ * @return $value Auth_OpenID_AX_Error on failure or the value of
+ * the attribute in the fetch_response message, or the default
+ * supplied
+ */
+ function getSingle($type_uri, $default=null)
+ {
+ $values = Auth_OpenID::arrayGet($this->data, $type_uri);
+ if (!$values) {
+ return $default;
+ } else if (count($values) == 1) {
+ return $values[0];
+ } else {
+ return new Auth_OpenID_AX_Error(
+ sprintf('More than one value present for %s',
+ $type_uri)
+ );
+ }
+ }
+
+ /**
+ * Get the list of values for this attribute in the
+ * fetch_response.
+ *
+ * XXX: what to do if the values are not present? default
+ * parameter? this is funny because it's always supposed to return
+ * a list, so the default may break that, though it's provided by
+ * the user's code, so it might be okay. If no default is
+ * supplied, should the return be None or []?
+ *
+ * @param type_uri: The URI of the attribute
+ *
+ * @return $values The list of values for this attribute in the
+ * response. May be an empty list. If the attribute was not sent
+ * in the response, returns Auth_OpenID_AX_Error.
+ */
+ function get($type_uri)
+ {
+ if (array_key_exists($type_uri, $this->data)) {
+ return $this->data[$type_uri];
+ } else {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Type URI %s not found in response",
+ $type_uri)
+ );
+ }
+ }
+
+ /**
+ * Get the number of responses for a particular attribute in this
+ * fetch_response message.
+ *
+ * @param type_uri: The URI of the attribute
+ *
+ * @returns int The number of values sent for this attribute. If
+ * the attribute was not sent in the response, returns
+ * Auth_OpenID_AX_Error.
+ */
+ function count($type_uri)
+ {
+ if (array_key_exists($type_uri, $this->data)) {
+ return count($this->get($type_uri));
+ } else {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Type URI %s not found in response",
+ $type_uri)
+ );
+ }
+ }
+}
+
+/**
+ * A fetch_response attribute exchange message.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_FetchResponse extends Auth_OpenID_AX_KeyValueMessage {
+ var $mode = 'fetch_response';
+
+ function Auth_OpenID_AX_FetchResponse($update_url=null)
+ {
+ $this->Auth_OpenID_AX_KeyValueMessage();
+ $this->update_url = $update_url;
+ }
+
+ /**
+ * Serialize this object into arguments in the attribute exchange
+ * namespace
+ *
+ * @return $args The dictionary of unqualified attribute exchange
+ * arguments that represent this fetch_response, or
+ * Auth_OpenID_AX_Error on error.
+ */
+ function getExtensionArgs($request=null)
+ {
+ $aliases = new Auth_OpenID_NamespaceMap();
+
+ $zero_value_types = array();
+
+ if ($request !== null) {
+ // Validate the data in the context of the request (the
+ // same attributes should be present in each, and the
+ // counts in the response must be no more than the counts
+ // in the request)
+
+ foreach ($this->data as $type_uri => $unused) {
+ if (!$request->contains($type_uri)) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Response attribute not present in request: %s",
+ $type_uri)
+ );
+ }
+ }
+
+ foreach ($request->iterAttrs() as $attr_info) {
+ // Copy the aliases from the request so that reading
+ // the response in light of the request is easier
+ if ($attr_info->alias === null) {
+ $aliases->add($attr_info->type_uri);
+ } else {
+ $alias = $aliases->addAlias($attr_info->type_uri,
+ $attr_info->alias);
+
+ if ($alias === null) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("Could not add alias %s for URI %s",
+ $attr_info->alias, $attr_info->type_uri)
+ );
+ }
+ }
+
+ if (array_key_exists($attr_info->type_uri, $this->data)) {
+ $values = $this->data[$attr_info->type_uri];
+ } else {
+ $values = array();
+ $zero_value_types[] = $attr_info;
+ }
+
+ if (($attr_info->count != Auth_OpenID_AX_UNLIMITED_VALUES) &&
+ ($attr_info->count < count($values))) {
+ return new Auth_OpenID_AX_Error(
+ sprintf("More than the number of requested values " .
+ "were specified for %s",
+ $attr_info->type_uri)
+ );
+ }
+ }
+ }
+
+ $kv_args = $this->_getExtensionKVArgs($aliases);
+
+ // Add the KV args into the response with the args that are
+ // unique to the fetch_response
+ $ax_args = $this->_newArgs();
+
+ // For each requested attribute, put its type/alias and count
+ // into the response even if no data were returned.
+ foreach ($zero_value_types as $attr_info) {
+ $alias = $aliases->getAlias($attr_info->type_uri);
+ $kv_args['type.' . $alias] = $attr_info->type_uri;
+ $kv_args['count.' . $alias] = '0';
+ }
+
+ $update_url = null;
+ if ($request) {
+ $update_url = $request->update_url;
+ } else {
+ $update_url = $this->update_url;
+ }
+
+ if ($update_url) {
+ $ax_args['update_url'] = $update_url;
+ }
+
+ Auth_OpenID::update($ax_args, $kv_args);
+
+ return $ax_args;
+ }
+
+ /**
+ * @return $result Auth_OpenID_AX_Error on failure or true on
+ * success.
+ */
+ function parseExtensionArgs($ax_args)
+ {
+ $result = parent::parseExtensionArgs($ax_args);
+
+ if (Auth_OpenID_AX::isError($result)) {
+ return $result;
+ }
+
+ $this->update_url = Auth_OpenID::arrayGet($ax_args, 'update_url');
+
+ return true;
+ }
+
+ /**
+ * Construct a FetchResponse object from an OpenID library
+ * SuccessResponse object.
+ *
+ * @param success_response: A successful id_res response object
+ *
+ * @param signed: Whether non-signed args should be processsed. If
+ * True (the default), only signed arguments will be processsed.
+ *
+ * @return $response A FetchResponse containing the data from the
+ * OpenID message
+ */
+ static function fromSuccessResponse($success_response, $signed=true)
+ {
+ $obj = new Auth_OpenID_AX_FetchResponse();
+ if ($signed) {
+ $ax_args = $success_response->getSignedNS($obj->ns_uri);
+ } else {
+ $ax_args = $success_response->message->getArgs($obj->ns_uri);
+ }
+ if ($ax_args === null || Auth_OpenID::isFailure($ax_args) ||
+ sizeof($ax_args) == 0) {
+ return null;
+ }
+
+ $result = $obj->parseExtensionArgs($ax_args);
+ if (Auth_OpenID_AX::isError($result)) {
+ #XXX log me
+ return null;
+ }
+ return $obj;
+ }
+}
+
+/**
+ * A store request attribute exchange message representation.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_StoreRequest extends Auth_OpenID_AX_KeyValueMessage {
+ var $mode = 'store_request';
+
+ /**
+ * @param array $aliases The namespace aliases to use when making
+ * this store response. Leave as None to use defaults.
+ */
+ function getExtensionArgs($aliases=null)
+ {
+ $ax_args = $this->_newArgs();
+ $kv_args = $this->_getExtensionKVArgs($aliases);
+ Auth_OpenID::update($ax_args, $kv_args);
+ return $ax_args;
+ }
+}
+
+/**
+ * An indication that the store request was processed along with this
+ * OpenID transaction. Use make(), NOT the constructor, to create
+ * response objects.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AX_StoreResponse extends Auth_OpenID_AX_Message {
+ var $SUCCESS_MODE = 'store_response_success';
+ var $FAILURE_MODE = 'store_response_failure';
+
+ /**
+ * Returns Auth_OpenID_AX_Error on error or an
+ * Auth_OpenID_AX_StoreResponse object on success.
+ */
+ function make($succeeded=true, $error_message=null)
+ {
+ if (($succeeded) && ($error_message !== null)) {
+ return new Auth_OpenID_AX_Error('An error message may only be '.
+ 'included in a failing fetch response');
+ }
+
+ return new Auth_OpenID_AX_StoreResponse($succeeded, $error_message);
+ }
+
+ function Auth_OpenID_AX_StoreResponse($succeeded=true, $error_message=null)
+ {
+ if ($succeeded) {
+ $this->mode = $this->SUCCESS_MODE;
+ } else {
+ $this->mode = $this->FAILURE_MODE;
+ }
+
+ $this->error_message = $error_message;
+ }
+
+ /**
+ * Was this response a success response?
+ */
+ function succeeded()
+ {
+ return $this->mode == $this->SUCCESS_MODE;
+ }
+
+ function getExtensionArgs()
+ {
+ $ax_args = $this->_newArgs();
+ if ((!$this->succeeded()) && $this->error_message) {
+ $ax_args['error'] = $this->error_message;
+ }
+
+ return $ax_args;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Association.php
@@ -1,1 +1,611 @@
-
+<?php
+
+/**
+ * This module contains code for dealing with associations between
+ * consumers and servers.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/CryptUtil.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/KVForm.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/HMAC.php';
+
+/**
+ * This class represents an association between a server and a
+ * consumer. In general, users of this library will never see
+ * instances of this object. The only exception is if you implement a
+ * custom {@link Auth_OpenID_OpenIDStore}.
+ *
+ * If you do implement such a store, it will need to store the values
+ * of the handle, secret, issued, lifetime, and assoc_type instance
+ * variables.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Association {
+
+ /**
+ * This is a HMAC-SHA1 specific value.
+ *
+ * @access private
+ */
+ var $SIG_LENGTH = 20;
+
+ /**
+ * The ordering and name of keys as stored by serialize.
+ *
+ * @access private
+ */
+ var $assoc_keys = array(
+ 'version',
+ 'handle',
+ 'secret',
+ 'issued',
+ 'lifetime',
+ 'assoc_type'
+ );
+
+ var $_macs = array(
+ 'HMAC-SHA1' => 'Auth_OpenID_HMACSHA1',
+ 'HMAC-SHA256' => 'Auth_OpenID_HMACSHA256'
+ );
+
+ /**
+ * This is an alternate constructor (factory method) used by the
+ * OpenID consumer library to create associations. OpenID store
+ * implementations shouldn't use this constructor.
+ *
+ * @access private
+ *
+ * @param integer $expires_in This is the amount of time this
+ * association is good for, measured in seconds since the
+ * association was issued.
+ *
+ * @param string $handle This is the handle the server gave this
+ * association.
+ *
+ * @param string secret This is the shared secret the server
+ * generated for this association.
+ *
+ * @param assoc_type This is the type of association this
+ * instance represents. The only valid values of this field at
+ * this time is 'HMAC-SHA1' and 'HMAC-SHA256', but new types may
+ * be defined in the future.
+ *
+ * @return association An {@link Auth_OpenID_Association}
+ * instance.
+ */
+ static function fromExpiresIn($expires_in, $handle, $secret, $assoc_type)
+ {
+ $issued = time();
+ $lifetime = $expires_in;
+ return new Auth_OpenID_Association($handle, $secret,
+ $issued, $lifetime, $assoc_type);
+ }
+
+ /**
+ * This is the standard constructor for creating an association.
+ * The library should create all of the necessary associations, so
+ * this constructor is not part of the external API.
+ *
+ * @access private
+ *
+ * @param string $handle This is the handle the server gave this
+ * association.
+ *
+ * @param string $secret This is the shared secret the server
+ * generated for this association.
+ *
+ * @param integer $issued This is the time this association was
+ * issued, in seconds since 00:00 GMT, January 1, 1970. (ie, a
+ * unix timestamp)
+ *
+ * @param integer $lifetime This is the amount of time this
+ * association is good for, measured in seconds since the
+ * association was issued.
+ *
+ * @param string $assoc_type This is the type of association this
+ * instance represents. The only valid values of this field at
+ * this time is 'HMAC-SHA1' and 'HMAC-SHA256', but new types may
+ * be defined in the future.
+ */
+ function Auth_OpenID_Association(
+ $handle, $secret, $issued, $lifetime, $assoc_type)
+ {
+ if (!in_array($assoc_type,
+ Auth_OpenID_getSupportedAssociationTypes(), true)) {
+ $fmt = 'Unsupported association type (%s)';
+ trigger_error(sprintf($fmt, $assoc_type), E_USER_ERROR);
+ }
+
+ $this->handle = $handle;
+ $this->secret = $secret;
+ $this->issued = $issued;
+ $this->lifetime = $lifetime;
+ $this->assoc_type = $assoc_type;
+ }
+
+ /**
+ * This returns the number of seconds this association is still
+ * valid for, or 0 if the association is no longer valid.
+ *
+ * @return integer $seconds The number of seconds this association
+ * is still valid for, or 0 if the association is no longer valid.
+ */
+ function getExpiresIn($now = null)
+ {
+ if ($now == null) {
+ $now = time();
+ }
+
+ return max(0, $this->issued + $this->lifetime - $now);
+ }
+
+ /**
+ * This checks to see if two {@link Auth_OpenID_Association}
+ * instances represent the same association.
+ *
+ * @return bool $result true if the two instances represent the
+ * same association, false otherwise.
+ */
+ function equal($other)
+ {
+ return ((gettype($this) == gettype($other))
+ && ($this->handle == $other->handle)
+ && ($this->secret == $other->secret)
+ && ($this->issued == $other->issued)
+ && ($this->lifetime == $other->lifetime)
+ && ($this->assoc_type == $other->assoc_type));
+ }
+
+ /**
+ * Convert an association to KV form.
+ *
+ * @return string $result String in KV form suitable for
+ * deserialization by deserialize.
+ */
+ function serialize()
+ {
+ $data = array(
+ 'version' => '2',
+ 'handle' => $this->handle,
+ 'secret' => base64_encode($this->secret),
+ 'issued' => strval(intval($this->issued)),
+ 'lifetime' => strval(intval($this->lifetime)),
+ 'assoc_type' => $this->assoc_type
+ );
+
+ assert(array_keys($data) == $this->assoc_keys);
+
+ return Auth_OpenID_KVForm::fromArray($data, $strict = true);
+ }
+
+ /**
+ * Parse an association as stored by serialize(). This is the
+ * inverse of serialize.
+ *
+ * @param string $assoc_s Association as serialized by serialize()
+ * @return Auth_OpenID_Association $result instance of this class
+ */
+ static function deserialize($class_name, $assoc_s)
+ {
+ $pairs = Auth_OpenID_KVForm::toArray($assoc_s, $strict = true);
+ $keys = array();
+ $values = array();
+ foreach ($pairs as $key => $value) {
+ if (is_array($value)) {
+ list($key, $value) = $value;
+ }
+ $keys[] = $key;
+ $values[] = $value;
+ }
+
+ $class_vars = get_class_vars($class_name);
+ $class_assoc_keys = $class_vars['assoc_keys'];
+
+ sort($keys);
+ sort($class_assoc_keys);
+
+ if ($keys != $class_assoc_keys) {
+ trigger_error('Unexpected key values: ' . var_export($keys, true),
+ E_USER_WARNING);
+ return null;
+ }
+
+ $version = $pairs['version'];
+ $handle = $pairs['handle'];
+ $secret = $pairs['secret'];
+ $issued = $pairs['issued'];
+ $lifetime = $pairs['lifetime'];
+ $assoc_type = $pairs['assoc_type'];
+
+ if ($version != '2') {
+ trigger_error('Unknown version: ' . $version, E_USER_WARNING);
+ return null;
+ }
+
+ $issued = intval($issued);
+ $lifetime = intval($lifetime);
+ $secret = base64_decode($secret);
+
+ return new $class_name(
+ $handle, $secret, $issued, $lifetime, $assoc_type);
+ }
+
+ /**
+ * Generate a signature for a sequence of (key, value) pairs
+ *
+ * @access private
+ * @param array $pairs The pairs to sign, in order. This is an
+ * array of two-tuples.
+ * @return string $signature The binary signature of this sequence
+ * of pairs
+ */
+ function sign($pairs)
+ {
+ $kv = Auth_OpenID_KVForm::fromArray($pairs);
+
+ /* Invalid association types should be caught at constructor */
+ $callback = $this->_macs[$this->assoc_type];
+
+ return call_user_func_array($callback, array($this->secret, $kv));
+ }
+
+ /**
+ * Generate a signature for some fields in a dictionary
+ *
+ * @access private
+ * @param array $fields The fields to sign, in order; this is an
+ * array of strings.
+ * @param array $data Dictionary of values to sign (an array of
+ * string => string pairs).
+ * @return string $signature The signature, base64 encoded
+ */
+ function signMessage($message)
+ {
+ if ($message->hasKey(Auth_OpenID_OPENID_NS, 'sig') ||
+ $message->hasKey(Auth_OpenID_OPENID_NS, 'signed')) {
+ // Already has a sig
+ return null;
+ }
+
+ $extant_handle = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'assoc_handle');
+
+ if ($extant_handle && ($extant_handle != $this->handle)) {
+ // raise ValueError("Message has a different association handle")
+ return null;
+ }
+
+ $signed_message = $message;
+ $signed_message->setArg(Auth_OpenID_OPENID_NS, 'assoc_handle',
+ $this->handle);
+
+ $message_keys = array_keys($signed_message->toPostArgs());
+ $signed_list = array();
+ $signed_prefix = 'openid.';
+
+ foreach ($message_keys as $k) {
+ if (strpos($k, $signed_prefix) === 0) {
+ $signed_list[] = substr($k, strlen($signed_prefix));
+ }
+ }
+
+ $signed_list[] = 'signed';
+ sort($signed_list);
+
+ $signed_message->setArg(Auth_OpenID_OPENID_NS, 'signed',
+ implode(',', $signed_list));
+ $sig = $this->getMessageSignature($signed_message);
+ $signed_message->setArg(Auth_OpenID_OPENID_NS, 'sig', $sig);
+ return $signed_message;
+ }
+
+ /**
+ * Given a {@link Auth_OpenID_Message}, return the key/value pairs
+ * to be signed according to the signed list in the message. If
+ * the message lacks a signed list, return null.
+ *
+ * @access private
+ */
+ function _makePairs($message)
+ {
+ $signed = $message->getArg(Auth_OpenID_OPENID_NS, 'signed');
+ if (!$signed || Auth_OpenID::isFailure($signed)) {
+ // raise ValueError('Message has no signed list: %s' % (message,))
+ return null;
+ }
+
+ $signed_list = explode(',', $signed);
+ $pairs = array();
+ $data = $message->toPostArgs();
+ foreach ($signed_list as $field) {
+ $pairs[] = array($field, Auth_OpenID::arrayGet($data,
+ 'openid.' .
+ $field, ''));
+ }
+ return $pairs;
+ }
+
+ /**
+ * Given an {@link Auth_OpenID_Message}, return the signature for
+ * the signed list in the message.
+ *
+ * @access private
+ */
+ function getMessageSignature($message)
+ {
+ $pairs = $this->_makePairs($message);
+ return base64_encode($this->sign($pairs));
+ }
+
+ /**
+ * Confirm that the signature of these fields matches the
+ * signature contained in the data.
+ *
+ * @access private
+ */
+ function checkMessageSignature($message)
+ {
+ $sig = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'sig');
+
+ if (!$sig || Auth_OpenID::isFailure($sig)) {
+ return false;
+ }
+
+ $calculated_sig = $this->getMessageSignature($message);
+ return Auth_OpenID_CryptUtil::constEq($calculated_sig, $sig);
+ }
+}
+
+function Auth_OpenID_getSecretSize($assoc_type)
+{
+ if ($assoc_type == 'HMAC-SHA1') {
+ return 20;
+ } else if ($assoc_type == 'HMAC-SHA256') {
+ return 32;
+ } else {
+ return null;
+ }
+}
+
+function Auth_OpenID_getAllAssociationTypes()
+{
+ return array('HMAC-SHA1', 'HMAC-SHA256');
+}
+
+function Auth_OpenID_getSupportedAssociationTypes()
+{
+ $a = array('HMAC-SHA1');
+
+ if (Auth_OpenID_HMACSHA256_SUPPORTED) {
+ $a[] = 'HMAC-SHA256';
+ }
+
+ return $a;
+}
+
+function Auth_OpenID_getSessionTypes($assoc_type)
+{
+ $assoc_to_session = array(
+ 'HMAC-SHA1' => array('DH-SHA1', 'no-encryption'));
+
+ if (Auth_OpenID_HMACSHA256_SUPPORTED) {
+ $assoc_to_session['HMAC-SHA256'] =
+ array('DH-SHA256', 'no-encryption');
+ }
+
+ return Auth_OpenID::arrayGet($assoc_to_session, $assoc_type, array());
+}
+
+function Auth_OpenID_checkSessionType($assoc_type, $session_type)
+{
+ if (!in_array($session_type,
+ Auth_OpenID_getSessionTypes($assoc_type))) {
+ return false;
+ }
+
+ return true;
+}
+
+function Auth_OpenID_getDefaultAssociationOrder()
+{
+ $order = array();
+
+ if (!Auth_OpenID_noMathSupport()) {
+ $order[] = array('HMAC-SHA1', 'DH-SHA1');
+
+ if (Auth_OpenID_HMACSHA256_SUPPORTED) {
+ $order[] = array('HMAC-SHA256', 'DH-SHA256');
+ }
+ }
+
+ $order[] = array('HMAC-SHA1', 'no-encryption');
+
+ if (Auth_OpenID_HMACSHA256_SUPPORTED) {
+ $order[] = array('HMAC-SHA256', 'no-encryption');
+ }
+
+ return $order;
+}
+
+function Auth_OpenID_getOnlyEncryptedOrder()
+{
+ $result = array();
+
+ foreach (Auth_OpenID_getDefaultAssociationOrder() as $pair) {
+ list($assoc, $session) = $pair;
+
+ if ($session != 'no-encryption') {
+ if (Auth_OpenID_HMACSHA256_SUPPORTED &&
+ ($assoc == 'HMAC-SHA256')) {
+ $result[] = $pair;
+ } else if ($assoc != 'HMAC-SHA256') {
+ $result[] = $pair;
+ }
+ }
+ }
+
+ return $result;
+}
+
+function Auth_OpenID_getDefaultNegotiator()
+{
+ return new Auth_OpenID_SessionNegotiator(
+ Auth_OpenID_getDefaultAssociationOrder());
+}
+
+function Auth_OpenID_getEncryptedNegotiator()
+{
+ return new Auth_OpenID_SessionNegotiator(
+ Auth_OpenID_getOnlyEncryptedOrder());
+}
+
+/**
+ * A session negotiator controls the allowed and preferred association
+ * types and association session types. Both the {@link
+ * Auth_OpenID_Consumer} and {@link Auth_OpenID_Server} use
+ * negotiators when creating associations.
+ *
+ * You can create and use negotiators if you:
+
+ * - Do not want to do Diffie-Hellman key exchange because you use
+ * transport-layer encryption (e.g. SSL)
+ *
+ * - Want to use only SHA-256 associations
+ *
+ * - Do not want to support plain-text associations over a non-secure
+ * channel
+ *
+ * It is up to you to set a policy for what kinds of associations to
+ * accept. By default, the library will make any kind of association
+ * that is allowed in the OpenID 2.0 specification.
+ *
+ * Use of negotiators in the library
+ * =================================
+ *
+ * When a consumer makes an association request, it calls {@link
+ * getAllowedType} to get the preferred association type and
+ * association session type.
+ *
+ * The server gets a request for a particular association/session type
+ * and calls {@link isAllowed} to determine if it should create an
+ * association. If it is supported, negotiation is complete. If it is
+ * not, the server calls {@link getAllowedType} to get an allowed
+ * association type to return to the consumer.
+ *
+ * If the consumer gets an error response indicating that the
+ * requested association/session type is not supported by the server
+ * that contains an assocation/session type to try, it calls {@link
+ * isAllowed} to determine if it should try again with the given
+ * combination of association/session type.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SessionNegotiator {
+ function Auth_OpenID_SessionNegotiator($allowed_types)
+ {
+ $this->allowed_types = array();
+ $this->setAllowedTypes($allowed_types);
+ }
+
+ /**
+ * Set the allowed association types, checking to make sure each
+ * combination is valid.
+ *
+ * @access private
+ */
+ function setAllowedTypes($allowed_types)
+ {
+ foreach ($allowed_types as $pair) {
+ list($assoc_type, $session_type) = $pair;
+ if (!Auth_OpenID_checkSessionType($assoc_type, $session_type)) {
+ return false;
+ }
+ }
+
+ $this->allowed_types = $allowed_types;
+ return true;
+ }
+
+ /**
+ * Add an association type and session type to the allowed types
+ * list. The assocation/session pairs are tried in the order that
+ * they are added.
+ *
+ * @access private
+ */
+ function addAllowedType($assoc_type, $session_type = null)
+ {
+ if ($this->allowed_types === null) {
+ $this->allowed_types = array();
+ }
+
+ if ($session_type === null) {
+ $available = Auth_OpenID_getSessionTypes($assoc_type);
+
+ if (!$available) {
+ return false;
+ }
+
+ foreach ($available as $session_type) {
+ $this->addAllowedType($assoc_type, $session_type);
+ }
+ } else {
+ if (Auth_OpenID_checkSessionType($assoc_type, $session_type)) {
+ $this->allowed_types[] = array($assoc_type, $session_type);
+ } else {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ // Is this combination of association type and session type allowed?
+ function isAllowed($assoc_type, $session_type)
+ {
+ $assoc_good = in_array(array($assoc_type, $session_type),
+ $this->allowed_types);
+
+ $matches = in_array($session_type,
+ Auth_OpenID_getSessionTypes($assoc_type));
+
+ return ($assoc_good && $matches);
+ }
+
+ /**
+ * Get a pair of assocation type and session type that are
+ * supported.
+ */
+ function getAllowedType()
+ {
+ if (!$this->allowed_types) {
+ return array(null, null);
+ }
+
+ return $this->allowed_types[0];
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/BigMath.php
@@ -1,1 +1,452 @@
-
+<?php
+
+/**
+ * BigMath: A math library wrapper that abstracts out the underlying
+ * long integer library.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @access private
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Needed for random number generation
+ */
+require_once 'Auth/OpenID/CryptUtil.php';
+
+/**
+ * Need Auth_OpenID::bytes().
+ */
+require_once 'Auth/OpenID.php';
+
+/**
+ * The superclass of all big-integer math implementations
+ * @access private
+ * @package OpenID
+ */
+class Auth_OpenID_MathLibrary {
+ /**
+ * Given a long integer, returns the number converted to a binary
+ * string. This function accepts long integer values of arbitrary
+ * magnitude and uses the local large-number math library when
+ * available.
+ *
+ * @param integer $long The long number (can be a normal PHP
+ * integer or a number created by one of the available long number
+ * libraries)
+ * @return string $binary The binary version of $long
+ */
+ function longToBinary($long)
+ {
+ $cmp = $this->cmp($long, 0);
+ if ($cmp < 0) {
+ $msg = __FUNCTION__ . " takes only positive integers.";
+ trigger_error($msg, E_USER_ERROR);
+ return null;
+ }
+
+ if ($cmp == 0) {
+ return "\x00";
+ }
+
+ $bytes = array();
+
+ while ($this->cmp($long, 0) > 0) {
+ array_unshift($bytes, $this->mod($long, 256));
+ $long = $this->div($long, pow(2, 8));
+ }
+
+ if ($bytes && ($bytes[0] > 127)) {
+ array_unshift($bytes, 0);
+ }
+
+ $string = '';
+ foreach ($bytes as $byte) {
+ $string .= pack('C', $byte);
+ }
+
+ return $string;
+ }
+
+ /**
+ * Given a binary string, returns the binary string converted to a
+ * long number.
+ *
+ * @param string $binary The binary version of a long number,
+ * probably as a result of calling longToBinary
+ * @return integer $long The long number equivalent of the binary
+ * string $str
+ */
+ function binaryToLong($str)
+ {
+ if ($str === null) {
+ return null;
+ }
+
+ // Use array_merge to return a zero-indexed array instead of a
+ // one-indexed array.
+ $bytes = array_merge(unpack('C*', $str));
+
+ $n = $this->init(0);
+
+ if ($bytes && ($bytes[0] > 127)) {
+ trigger_error("bytesToNum works only for positive integers.",
+ E_USER_WARNING);
+ return null;
+ }
+
+ foreach ($bytes as $byte) {
+ $n = $this->mul($n, pow(2, 8));
+ $n = $this->add($n, $byte);
+ }
+
+ return $n;
+ }
+
+ function base64ToLong($str)
+ {
+ $b64 = base64_decode($str);
+
+ if ($b64 === false) {
+ return false;
+ }
+
+ return $this->binaryToLong($b64);
+ }
+
+ function longToBase64($str)
+ {
+ return base64_encode($this->longToBinary($str));
+ }
+
+ /**
+ * Returns a random number in the specified range. This function
+ * accepts $start, $stop, and $step values of arbitrary magnitude
+ * and will utilize the local large-number math library when
+ * available.
+ *
+ * @param integer $start The start of the range, or the minimum
+ * random number to return
+ * @param integer $stop The end of the range, or the maximum
+ * random number to return
+ * @param integer $step The step size, such that $result - ($step
+ * * N) = $start for some N
+ * @return integer $result The resulting randomly-generated number
+ */
+ function rand($stop)
+ {
+ static $duplicate_cache = array();
+
+ // Used as the key for the duplicate cache
+ $rbytes = $this->longToBinary($stop);
+
+ if (array_key_exists($rbytes, $duplicate_cache)) {
+ list($duplicate, $nbytes) = $duplicate_cache[$rbytes];
+ } else {
+ if ($rbytes[0] == "\x00") {
+ $nbytes = Auth_OpenID::bytes($rbytes) - 1;
+ } else {
+ $nbytes = Auth_OpenID::bytes($rbytes);
+ }
+
+ $mxrand = $this->pow(256, $nbytes);
+
+ // If we get a number less than this, then it is in the
+ // duplicated range.
+ $duplicate = $this->mod($mxrand, $stop);
+
+ if (count($duplicate_cache) > 10) {
+ $duplicate_cache = array();
+ }
+
+ $duplicate_cache[$rbytes] = array($duplicate, $nbytes);
+ }
+
+ do {
+ $bytes = "\x00" . Auth_OpenID_CryptUtil::getBytes($nbytes);
+ $n = $this->binaryToLong($bytes);
+ // Keep looping if this value is in the low duplicated range
+ } while ($this->cmp($n, $duplicate) < 0);
+
+ return $this->mod($n, $stop);
+ }
+}
+
+/**
+ * Exposes BCmath math library functionality.
+ *
+ * {@link Auth_OpenID_BcMathWrapper} wraps the functionality provided
+ * by the BCMath extension.
+ *
+ * @access private
+ * @package OpenID
+ */
+class Auth_OpenID_BcMathWrapper extends Auth_OpenID_MathLibrary{
+ var $type = 'bcmath';
+
+ function add($x, $y)
+ {
+ return bcadd($x, $y);
+ }
+
+ function sub($x, $y)
+ {
+ return bcsub($x, $y);
+ }
+
+ function pow($base, $exponent)
+ {
+ return bcpow($base, $exponent);
+ }
+
+ function cmp($x, $y)
+ {
+ return bccomp($x, $y);
+ }
+
+ function init($number, $base = 10)
+ {
+ return $number;
+ }
+
+ function mod($base, $modulus)
+ {
+ return bcmod($base, $modulus);
+ }
+
+ function mul($x, $y)
+ {
+ return bcmul($x, $y);
+ }
+
+ function div($x, $y)
+ {
+ return bcdiv($x, $y);
+ }
+
+ /**
+ * Same as bcpowmod when bcpowmod is missing
+ *
+ * @access private
+ */
+ function _powmod($base, $exponent, $modulus)
+ {
+ $square = $this->mod($base, $modulus);
+ $result = 1;
+ while($this->cmp($exponent, 0) > 0) {
+ if ($this->mod($exponent, 2)) {
+ $result = $this->mod($this->mul($result, $square), $modulus);
+ }
+ $square = $this->mod($this->mul($square, $square), $modulus);
+ $exponent = $this->div($exponent, 2);
+ }
+ return $result;
+ }
+
+ function powmod($base, $exponent, $modulus)
+ {
+ if (function_exists('bcpowmod')) {
+ return bcpowmod($base, $exponent, $modulus);
+ } else {
+ return $this->_powmod($base, $exponent, $modulus);
+ }
+ }
+
+ function toString($num)
+ {
+ return $num;
+ }
+}
+
+/**
+ * Exposes GMP math library functionality.
+ *
+ * {@link Auth_OpenID_GmpMathWrapper} wraps the functionality provided
+ * by the GMP extension.
+ *
+ * @access private
+ * @package OpenID
+ */
+class Auth_OpenID_GmpMathWrapper extends Auth_OpenID_MathLibrary{
+ var $type = 'gmp';
+
+ function add($x, $y)
+ {
+ return gmp_add($x, $y);
+ }
+
+ function sub($x, $y)
+ {
+ return gmp_sub($x, $y);
+ }
+
+ function pow($base, $exponent)
+ {
+ return gmp_pow($base, $exponent);
+ }
+
+ function cmp($x, $y)
+ {
+ return gmp_cmp($x, $y);
+ }
+
+ function init($number, $base = 10)
+ {
+ return gmp_init($number, $base);
+ }
+
+ function mod($base, $modulus)
+ {
+ return gmp_mod($base, $modulus);
+ }
+
+ function mul($x, $y)
+ {
+ return gmp_mul($x, $y);
+ }
+
+ function div($x, $y)
+ {
+ return gmp_div_q($x, $y);
+ }
+
+ function powmod($base, $exponent, $modulus)
+ {
+ return gmp_powm($base, $exponent, $modulus);
+ }
+
+ function toString($num)
+ {
+ return gmp_strval($num);
+ }
+}
+
+/**
+ * Define the supported extensions. An extension array has keys
+ * 'modules', 'extension', and 'class'. 'modules' is an array of PHP
+ * module names which the loading code will attempt to load. These
+ * values will be suffixed with a library file extension (e.g. ".so").
+ * 'extension' is the name of a PHP extension which will be tested
+ * before 'modules' are loaded. 'class' is the string name of a
+ * {@link Auth_OpenID_MathWrapper} subclass which should be
+ * instantiated if a given extension is present.
+ *
+ * You can define new math library implementations and add them to
+ * this array.
+ */
+function Auth_OpenID_math_extensions()
+{
+ $result = array();
+
+ if (!defined('Auth_OpenID_BUGGY_GMP')) {
+ $result[] =
+ array('modules' => array('gmp', 'php_gmp'),
+ 'extension' => 'gmp',
+ 'class' => 'Auth_OpenID_GmpMathWrapper');
+ }
+
+ $result[] = array('modules' => array('bcmath', 'php_bcmath'),
+ 'extension' => 'bcmath',
+ 'class' => 'Auth_OpenID_BcMathWrapper');
+
+ return $result;
+}
+
+/**
+ * Detect which (if any) math library is available
+ */
+function Auth_OpenID_detectMathLibrary($exts)
+{
+ $loaded = false;
+
+ foreach ($exts as $extension) {
+ if (extension_loaded($extension['extension'])) {
+ return $extension;
+ }
+ }
+
+ return false;
+}
+
+/**
+ * {@link Auth_OpenID_getMathLib} checks for the presence of long
+ * number extension modules and returns an instance of
+ * {@link Auth_OpenID_MathWrapper} which exposes the module's
+ * functionality.
+ *
+ * Checks for the existence of an extension module described by the
+ * result of {@link Auth_OpenID_math_extensions()} and returns an
+ * instance of a wrapper for that extension module. If no extension
+ * module is found, an instance of {@link Auth_OpenID_MathWrapper} is
+ * returned, which wraps the native PHP integer implementation. The
+ * proper calling convention for this method is $lib =
+ * Auth_OpenID_getMathLib().
+ *
+ * This function checks for the existence of specific long number
+ * implementations in the following order: GMP followed by BCmath.
+ *
+ * @return Auth_OpenID_MathWrapper $instance An instance of
+ * {@link Auth_OpenID_MathWrapper} or one of its subclasses
+ *
+ * @package OpenID
+ */
+function Auth_OpenID_getMathLib()
+{
+ // The instance of Auth_OpenID_MathWrapper that we choose to
+ // supply will be stored here, so that subseqent calls to this
+ // method will return a reference to the same object.
+ static $lib = null;
+
+ if (isset($lib)) {
+ return $lib;
+ }
+
+ if (Auth_OpenID_noMathSupport()) {
+ $null = null;
+ return $null;
+ }
+
+ // If this method has not been called before, look at
+ // Auth_OpenID_math_extensions and try to find an extension that
+ // works.
+ $ext = Auth_OpenID_detectMathLibrary(Auth_OpenID_math_extensions());
+ if ($ext === false) {
+ $tried = array();
+ foreach (Auth_OpenID_math_extensions() as $extinfo) {
+ $tried[] = $extinfo['extension'];
+ }
+ $triedstr = implode(", ", $tried);
+
+ Auth_OpenID_setNoMathSupport();
+
+ $result = null;
+ return $result;
+ }
+
+ // Instantiate a new wrapper
+ $class = $ext['class'];
+ $lib = new $class();
+
+ return $lib;
+}
+
+function Auth_OpenID_setNoMathSupport()
+{
+ if (!defined('Auth_OpenID_NO_MATH_SUPPORT')) {
+ define('Auth_OpenID_NO_MATH_SUPPORT', true);
+ }
+}
+
+function Auth_OpenID_noMathSupport()
+{
+ return defined('Auth_OpenID_NO_MATH_SUPPORT');
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Consumer.php
@@ -1,1 +1,2235 @@
-
+<?php
+
+/**
+ * This module documents the main interface with the OpenID consumer
+ * library. The only part of the library which has to be used and
+ * isn't documented in full here is the store required to create an
+ * Auth_OpenID_Consumer instance. More on the abstract store type and
+ * concrete implementations of it that are provided in the
+ * documentation for the Auth_OpenID_Consumer constructor.
+ *
+ * OVERVIEW
+ *
+ * The OpenID identity verification process most commonly uses the
+ * following steps, as visible to the user of this library:
+ *
+ * 1. The user enters their OpenID into a field on the consumer's
+ * site, and hits a login button.
+ * 2. The consumer site discovers the user's OpenID server using the
+ * YADIS protocol.
+ * 3. The consumer site sends the browser a redirect to the identity
+ * server. This is the authentication request as described in
+ * the OpenID specification.
+ * 4. The identity server's site sends the browser a redirect back
+ * to the consumer site. This redirect contains the server's
+ * response to the authentication request.
+ *
+ * The most important part of the flow to note is the consumer's site
+ * must handle two separate HTTP requests in order to perform the full
+ * identity check.
+ *
+ * LIBRARY DESIGN
+ *
+ * This consumer library is designed with that flow in mind. The goal
+ * is to make it as easy as possible to perform the above steps
+ * securely.
+ *
+ * At a high level, there are two important parts in the consumer
+ * library. The first important part is this module, which contains
+ * the interface to actually use this library. The second is the
+ * Auth_OpenID_Interface class, which describes the interface to use
+ * if you need to create a custom method for storing the state this
+ * library needs to maintain between requests.
+ *
+ * In general, the second part is less important for users of the
+ * library to know about, as several implementations are provided
+ * which cover a wide variety of situations in which consumers may use
+ * the library.
+ *
+ * This module contains a class, Auth_OpenID_Consumer, with methods
+ * corresponding to the actions necessary in each of steps 2, 3, and 4
+ * described in the overview. Use of this library should be as easy
+ * as creating an Auth_OpenID_Consumer instance and calling the
+ * methods appropriate for the action the site wants to take.
+ *
+ * STORES AND DUMB MODE
+ *
+ * OpenID is a protocol that works best when the consumer site is able
+ * to store some state. This is the normal mode of operation for the
+ * protocol, and is sometimes referred to as smart mode. There is
+ * also a fallback mode, known as dumb mode, which is available when
+ * the consumer site is not able to store state. This mode should be
+ * avoided when possible, as it leaves the implementation more
+ * vulnerable to replay attacks.
+ *
+ * The mode the library works in for normal operation is determined by
+ * the store that it is given. The store is an abstraction that
+ * handles the data that the consumer needs to manage between http
+ * requests in order to operate efficiently and securely.
+ *
+ * Several store implementation are provided, and the interface is
+ * fully documented so that custom stores can be used as well. See
+ * the documentation for the Auth_OpenID_Consumer class for more
+ * information on the interface for stores. The implementations that
+ * are provided allow the consumer site to store the necessary data in
+ * several different ways, including several SQL databases and normal
+ * files on disk.
+ *
+ * There is an additional concrete store provided that puts the system
+ * in dumb mode. This is not recommended, as it removes the library's
+ * ability to stop replay attacks reliably. It still uses time-based
+ * checking to make replay attacks only possible within a small
+ * window, but they remain possible within that window. This store
+ * should only be used if the consumer site has no way to retain data
+ * between requests at all.
+ *
+ * IMMEDIATE MODE
+ *
+ * In the flow described above, the user may need to confirm to the
+ * lidentity server that it's ok to authorize his or her identity.
+ * The server may draw pages asking for information from the user
+ * before it redirects the browser back to the consumer's site. This
+ * is generally transparent to the consumer site, so it is typically
+ * ignored as an implementation detail.
+ *
+ * There can be times, however, where the consumer site wants to get a
+ * response immediately. When this is the case, the consumer can put
+ * the library in immediate mode. In immediate mode, there is an
+ * extra response possible from the server, which is essentially the
+ * server reporting that it doesn't have enough information to answer
+ * the question yet.
+ *
+ * USING THIS LIBRARY
+ *
+ * Integrating this library into an application is usually a
+ * relatively straightforward process. The process should basically
+ * follow this plan:
+ *
+ * Add an OpenID login field somewhere on your site. When an OpenID
+ * is entered in that field and the form is submitted, it should make
+ * a request to the your site which includes that OpenID URL.
+ *
+ * First, the application should instantiate the Auth_OpenID_Consumer
+ * class using the store of choice (Auth_OpenID_FileStore or one of
+ * the SQL-based stores). If the application has a custom
+ * session-management implementation, an object implementing the
+ * {@link Auth_Yadis_PHPSession} interface should be passed as the
+ * second parameter. Otherwise, the default uses $_SESSION.
+ *
+ * Next, the application should call the Auth_OpenID_Consumer object's
+ * 'begin' method. This method takes the OpenID URL. The 'begin'
+ * method returns an Auth_OpenID_AuthRequest object.
+ *
+ * Next, the application should call the 'redirectURL' method of the
+ * Auth_OpenID_AuthRequest object. The 'return_to' URL parameter is
+ * the URL that the OpenID server will send the user back to after
+ * attempting to verify his or her identity. The 'trust_root' is the
+ * URL (or URL pattern) that identifies your web site to the user when
+ * he or she is authorizing it. Send a redirect to the resulting URL
+ * to the user's browser.
+ *
+ * That's the first half of the authentication process. The second
+ * half of the process is done after the user's ID server sends the
+ * user's browser a redirect back to your site to complete their
+ * login.
+ *
+ * When that happens, the user will contact your site at the URL given
+ * as the 'return_to' URL to the Auth_OpenID_AuthRequest::redirectURL
+ * call made above. The request will have several query parameters
+ * added to the URL by the identity server as the information
+ * necessary to finish the request.
+ *
+ * Lastly, instantiate an Auth_OpenID_Consumer instance as above and
+ * call its 'complete' method, passing in all the received query
+ * arguments.
+ *
+ * There are multiple possible return types possible from that
+ * method. These indicate the whether or not the login was successful,
+ * and include any additional information appropriate for their type.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Require utility classes and functions for the consumer.
+ */
+require_once "Auth/OpenID.php";
+require_once "Auth/OpenID/Message.php";
+require_once "Auth/OpenID/HMAC.php";
+require_once "Auth/OpenID/Association.php";
+require_once "Auth/OpenID/CryptUtil.php";
+require_once "Auth/OpenID/DiffieHellman.php";
+require_once "Auth/OpenID/KVForm.php";
+require_once "Auth/OpenID/Nonce.php";
+require_once "Auth/OpenID/Discover.php";
+require_once "Auth/OpenID/URINorm.php";
+require_once "Auth/Yadis/Manager.php";
+require_once "Auth/Yadis/XRI.php";
+
+/**
+ * This is the status code returned when the complete method returns
+ * successfully.
+ */
+define('Auth_OpenID_SUCCESS', 'success');
+
+/**
+ * Status to indicate cancellation of OpenID authentication.
+ */
+define('Auth_OpenID_CANCEL', 'cancel');
+
+/**
+ * This is the status code completeAuth returns when the value it
+ * received indicated an invalid login.
+ */
+define('Auth_OpenID_FAILURE', 'failure');
+
+/**
+ * This is the status code completeAuth returns when the
+ * {@link Auth_OpenID_Consumer} instance is in immediate mode, and the
+ * identity server sends back a URL to send the user to to complete his
+ * or her login.
+ */
+define('Auth_OpenID_SETUP_NEEDED', 'setup needed');
+
+/**
+ * This is the status code beginAuth returns when the page fetched
+ * from the entered OpenID URL doesn't contain the necessary link tags
+ * to function as an identity page.
+ */
+define('Auth_OpenID_PARSE_ERROR', 'parse error');
+
+/**
+ * An OpenID consumer implementation that performs discovery and does
+ * session management. See the Consumer.php file documentation for
+ * more information.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Consumer {
+
+ /**
+ * @access private
+ */
+ var $discoverMethod = 'Auth_OpenID_discover';
+
+ /**
+ * @access private
+ */
+ var $session_key_prefix = "_openid_consumer_";
+
+ /**
+ * @access private
+ */
+ var $_token_suffix = "last_token";
+
+ /**
+ * Initialize a Consumer instance.
+ *
+ * You should create a new instance of the Consumer object with
+ * every HTTP request that handles OpenID transactions.
+ *
+ * @param Auth_OpenID_OpenIDStore $store This must be an object
+ * that implements the interface in {@link
+ * Auth_OpenID_OpenIDStore}. Several concrete implementations are
+ * provided, to cover most common use cases. For stores backed by
+ * MySQL, PostgreSQL, or SQLite, see the {@link
+ * Auth_OpenID_SQLStore} class and its sublcasses. For a
+ * filesystem-backed store, see the {@link Auth_OpenID_FileStore}
+ * module. As a last resort, if it isn't possible for the server
+ * to store state at all, an instance of {@link
+ * Auth_OpenID_DumbStore} can be used.
+ *
+ * @param mixed $session An object which implements the interface
+ * of the {@link Auth_Yadis_PHPSession} class. Particularly, this
+ * object is expected to have these methods: get($key), set($key),
+ * $value), and del($key). This defaults to a session object
+ * which wraps PHP's native session machinery. You should only
+ * need to pass something here if you have your own sessioning
+ * implementation.
+ *
+ * @param str $consumer_cls The name of the class to instantiate
+ * when creating the internal consumer object. This is used for
+ * testing.
+ */
+ function Auth_OpenID_Consumer($store, $session = null,
+ $consumer_cls = null)
+ {
+ if ($session === null) {
+ $session = new Auth_Yadis_PHPSession();
+ }
+
+ $this->session = $session;
+
+ if ($consumer_cls !== null) {
+ $this->consumer = new $consumer_cls($store);
+ } else {
+ $this->consumer = new Auth_OpenID_GenericConsumer($store);
+ }
+
+ $this->_token_key = $this->session_key_prefix . $this->_token_suffix;
+ }
+
+ /**
+ * Used in testing to define the discovery mechanism.
+ *
+ * @access private
+ */
+ function getDiscoveryObject($session, $openid_url,
+ $session_key_prefix)
+ {
+ return new Auth_Yadis_Discovery($session, $openid_url,
+ $session_key_prefix);
+ }
+
+ /**
+ * Start the OpenID authentication process. See steps 1-2 in the
+ * overview at the top of this file.
+ *
+ * @param string $user_url Identity URL given by the user. This
+ * method performs a textual transformation of the URL to try and
+ * make sure it is normalized. For example, a user_url of
+ * example.com will be normalized to http://example.com/
+ * normalizing and resolving any redirects the server might issue.
+ *
+ * @param bool $anonymous True if the OpenID request is to be sent
+ * to the server without any identifier information. Use this
+ * when you want to transport data but don't want to do OpenID
+ * authentication with identifiers.
+ *
+ * @return Auth_OpenID_AuthRequest $auth_request An object
+ * containing the discovered information will be returned, with a
+ * method for building a redirect URL to the server, as described
+ * in step 3 of the overview. This object may also be used to add
+ * extension arguments to the request, using its 'addExtensionArg'
+ * method.
+ */
+ function begin($user_url, $anonymous=false)
+ {
+ $openid_url = $user_url;
+
+ $disco = $this->getDiscoveryObject($this->session,
+ $openid_url,
+ $this->session_key_prefix);
+
+ // Set the 'stale' attribute of the manager. If discovery
+ // fails in a fatal way, the stale flag will cause the manager
+ // to be cleaned up next time discovery is attempted.
+
+ $m = $disco->getManager();
+ $loader = new Auth_Yadis_ManagerLoader();
+
+ if ($m) {
+ if ($m->stale) {
+ $disco->destroyManager();
+ } else {
+ $m->stale = true;
+ $disco->session->set($disco->session_key,
+ serialize($loader->toSession($m)));
+ }
+ }
+
+ $endpoint = $disco->getNextService($this->discoverMethod,
+ $this->consumer->fetcher);
+
+ // Reset the 'stale' attribute of the manager.
+ $m = $disco->getManager();
+ if ($m) {
+ $m->stale = false;
+ $disco->session->set($disco->session_key,
+ serialize($loader->toSession($m)));
+ }
+
+ if ($endpoint === null) {
+ return null;
+ } else {
+ return $this->beginWithoutDiscovery($endpoint,
+ $anonymous);
+ }
+ }
+
+ /**
+ * Start OpenID verification without doing OpenID server
+ * discovery. This method is used internally by Consumer.begin
+ * after discovery is performed, and exists to provide an
+ * interface for library users needing to perform their own
+ * discovery.
+ *
+ * @param Auth_OpenID_ServiceEndpoint $endpoint an OpenID service
+ * endpoint descriptor.
+ *
+ * @param bool anonymous Set to true if you want to perform OpenID
+ * without identifiers.
+ *
+ * @return Auth_OpenID_AuthRequest $auth_request An OpenID
+ * authentication request object.
+ */
+ function beginWithoutDiscovery($endpoint, $anonymous=false)
+ {
+ $loader = new Auth_OpenID_ServiceEndpointLoader();
+ $auth_req = $this->consumer->begin($endpoint);
+ $this->session->set($this->_token_key,
+ $loader->toSession($auth_req->endpoint));
+ if (!$auth_req->setAnonymous($anonymous)) {
+ return new Auth_OpenID_FailureResponse(null,
+ "OpenID 1 requests MUST include the identifier " .
+ "in the request.");
+ }
+ return $auth_req;
+ }
+
+ /**
+ * Called to interpret the server's response to an OpenID
+ * request. It is called in step 4 of the flow described in the
+ * consumer overview.
+ *
+ * @param string $current_url The URL used to invoke the application.
+ * Extract the URL from your application's web
+ * request framework and specify it here to have it checked
+ * against the openid.current_url value in the response. If
+ * the current_url URL check fails, the status of the
+ * completion will be FAILURE.
+ *
+ * @param array $query An array of the query parameters (key =>
+ * value pairs) for this HTTP request. Defaults to null. If
+ * null, the GET or POST data are automatically gotten from the
+ * PHP environment. It is only useful to override $query for
+ * testing.
+ *
+ * @return Auth_OpenID_ConsumerResponse $response A instance of an
+ * Auth_OpenID_ConsumerResponse subclass. The type of response is
+ * indicated by the status attribute, which will be one of
+ * SUCCESS, CANCEL, FAILURE, or SETUP_NEEDED.
+ */
+ function complete($current_url, $query=null)
+ {
+ if ($current_url && !is_string($current_url)) {
+ // This is ugly, but we need to complain loudly when
+ // someone uses the API incorrectly.
+ trigger_error("current_url must be a string; see NEWS file " .
+ "for upgrading notes.",
+ E_USER_ERROR);
+ }
+
+ if ($query === null) {
+ $query = Auth_OpenID::getQuery();
+ }
+
+ $loader = new Auth_OpenID_ServiceEndpointLoader();
+ $endpoint_data = $this->session->get($this->_token_key);
+ $endpoint =
+ $loader->fromSession($endpoint_data);
+
+ $message = Auth_OpenID_Message::fromPostArgs($query);
+ $response = $this->consumer->complete($message, $endpoint,
+ $current_url);
+ $this->session->del($this->_token_key);
+
+ if (in_array($response->status, array(Auth_OpenID_SUCCESS,
+ Auth_OpenID_CANCEL))) {
+ if ($response->identity_url !== null) {
+ $disco = $this->getDiscoveryObject($this->session,
+ $response->identity_url,
+ $this->session_key_prefix);
+ $disco->cleanup(true);
+ }
+ }
+
+ return $response;
+ }
+}
+
+/**
+ * A class implementing HMAC/DH-SHA1 consumer sessions.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_DiffieHellmanSHA1ConsumerSession {
+ var $session_type = 'DH-SHA1';
+ var $hash_func = 'Auth_OpenID_SHA1';
+ var $secret_size = 20;
+ var $allowed_assoc_types = array('HMAC-SHA1');
+
+ function Auth_OpenID_DiffieHellmanSHA1ConsumerSession($dh = null)
+ {
+ if ($dh === null) {
+ $dh = new Auth_OpenID_DiffieHellman();
+ }
+
+ $this->dh = $dh;
+ }
+
+ function getRequest()
+ {
+ $math = Auth_OpenID_getMathLib();
+
+ $cpub = $math->longToBase64($this->dh->public);
+
+ $args = array('dh_consumer_public' => $cpub);
+
+ if (!$this->dh->usingDefaultValues()) {
+ $args = array_merge($args, array(
+ 'dh_modulus' =>
+ $math->longToBase64($this->dh->mod),
+ 'dh_gen' =>
+ $math->longToBase64($this->dh->gen)));
+ }
+
+ return $args;
+ }
+
+ function extractSecret($response)
+ {
+ if (!$response->hasKey(Auth_OpenID_OPENID_NS,
+ 'dh_server_public')) {
+ return null;
+ }
+
+ if (!$response->hasKey(Auth_OpenID_OPENID_NS,
+ 'enc_mac_key')) {
+ return null;
+ }
+
+ $math = Auth_OpenID_getMathLib();
+
+ $spub = $math->base64ToLong($response->getArg(Auth_OpenID_OPENID_NS,
+ 'dh_server_public'));
+ $enc_mac_key = base64_decode($response->getArg(Auth_OpenID_OPENID_NS,
+ 'enc_mac_key'));
+
+ return $this->dh->xorSecret($spub, $enc_mac_key, $this->hash_func);
+ }
+}
+
+/**
+ * A class implementing HMAC/DH-SHA256 consumer sessions.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_DiffieHellmanSHA256ConsumerSession extends
+ Auth_OpenID_DiffieHellmanSHA1ConsumerSession {
+ var $session_type = 'DH-SHA256';
+ var $hash_func = 'Auth_OpenID_SHA256';
+ var $secret_size = 32;
+ var $allowed_assoc_types = array('HMAC-SHA256');
+}
+
+/**
+ * A class implementing plaintext consumer sessions.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_PlainTextConsumerSession {
+ var $session_type = 'no-encryption';
+ var $allowed_assoc_types = array('HMAC-SHA1', 'HMAC-SHA256');
+
+ function getRequest()
+ {
+ return array();
+ }
+
+ function extractSecret($response)
+ {
+ if (!$response->hasKey(Auth_OpenID_OPENID_NS, 'mac_key')) {
+ return null;
+ }
+
+ return base64_decode($response->getArg(Auth_OpenID_OPENID_NS,
+ 'mac_key'));
+ }
+}
+
+/**
+ * Returns available session types.
+ */
+function Auth_OpenID_getAvailableSessionTypes()
+{
+ $types = array(
+ 'no-encryption' => 'Auth_OpenID_PlainTextConsumerSession',
+ 'DH-SHA1' => 'Auth_OpenID_DiffieHellmanSHA1ConsumerSession',
+ 'DH-SHA256' => 'Auth_OpenID_DiffieHellmanSHA256ConsumerSession');
+
+ return $types;
+}
+
+/**
+ * This class is the interface to the OpenID consumer logic.
+ * Instances of it maintain no per-request state, so they can be
+ * reused (or even used by multiple threads concurrently) as needed.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_GenericConsumer {
+ /**
+ * @access private
+ */
+ var $discoverMethod = 'Auth_OpenID_discover';
+
+ /**
+ * This consumer's store object.
+ */
+ var $store;
+
+ /**
+ * @access private
+ */
+ var $_use_assocs;
+
+ /**
+ * @access private
+ */
+ var $openid1_nonce_query_arg_name = 'janrain_nonce';
+
+ /**
+ * Another query parameter that gets added to the return_to for
+ * OpenID 1; if the user's session state is lost, use this claimed
+ * identifier to do discovery when verifying the response.
+ */
+ var $openid1_return_to_identifier_name = 'openid1_claimed_id';
+
+ /**
+ * This method initializes a new {@link Auth_OpenID_Consumer}
+ * instance to access the library.
+ *
+ * @param Auth_OpenID_OpenIDStore $store This must be an object
+ * that implements the interface in {@link Auth_OpenID_OpenIDStore}.
+ * Several concrete implementations are provided, to cover most common use
+ * cases. For stores backed by MySQL, PostgreSQL, or SQLite, see
+ * the {@link Auth_OpenID_SQLStore} class and its sublcasses. For a
+ * filesystem-backed store, see the {@link Auth_OpenID_FileStore} module.
+ * As a last resort, if it isn't possible for the server to store
+ * state at all, an instance of {@link Auth_OpenID_DumbStore} can be used.
+ *
+ * @param bool $immediate This is an optional boolean value. It
+ * controls whether the library uses immediate mode, as explained
+ * in the module description. The default value is False, which
+ * disables immediate mode.
+ */
+ function Auth_OpenID_GenericConsumer($store)
+ {
+ $this->store = $store;
+ $this->negotiator = Auth_OpenID_getDefaultNegotiator();
+ $this->_use_assocs = (is_null($this->store) ? false : true);
+
+ $this->fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
+
+ $this->session_types = Auth_OpenID_getAvailableSessionTypes();
+ }
+
+ /**
+ * Called to begin OpenID authentication using the specified
+ * {@link Auth_OpenID_ServiceEndpoint}.
+ *
+ * @access private
+ */
+ function begin($service_endpoint)
+ {
+ $assoc = $this->_getAssociation($service_endpoint);
+ $r = new Auth_OpenID_AuthRequest($service_endpoint, $assoc);
+ $r->return_to_args[$this->openid1_nonce_query_arg_name] =
+ Auth_OpenID_mkNonce();
+
+ if ($r->message->isOpenID1()) {
+ $r->return_to_args[$this->openid1_return_to_identifier_name] =
+ $r->endpoint->claimed_id;
+ }
+
+ return $r;
+ }
+
+ /**
+ * Given an {@link Auth_OpenID_Message}, {@link
+ * Auth_OpenID_ServiceEndpoint} and optional return_to URL,
+ * complete OpenID authentication.
+ *
+ * @access private
+ */
+ function complete($message, $endpoint, $return_to)
+ {
+ $mode = $message->getArg(Auth_OpenID_OPENID_NS, 'mode',
+ '<no mode set>');
+
+ $mode_methods = array(
+ 'cancel' => '_complete_cancel',
+ 'error' => '_complete_error',
+ 'setup_needed' => '_complete_setup_needed',
+ 'id_res' => '_complete_id_res',
+ );
+
+ $method = Auth_OpenID::arrayGet($mode_methods, $mode,
+ '_completeInvalid');
+
+ return call_user_func_array(array($this, $method),
+ array($message, &$endpoint, $return_to));
+ }
+
+ /**
+ * @access private
+ */
+ function _completeInvalid($message, $endpoint, $unused)
+ {
+ $mode = $message->getArg(Auth_OpenID_OPENID_NS, 'mode',
+ '<No mode set>');
+
+ return new Auth_OpenID_FailureResponse($endpoint,
+ sprintf("Invalid openid.mode '%s'", $mode));
+ }
+
+ /**
+ * @access private
+ */
+ function _complete_cancel($message, $endpoint, $unused)
+ {
+ return new Auth_OpenID_CancelResponse($endpoint);
+ }
+
+ /**
+ * @access private
+ */
+ function _complete_error($message, $endpoint, $unused)
+ {
+ $error = $message->getArg(Auth_OpenID_OPENID_NS, 'error');
+ $contact = $message->getArg(Auth_OpenID_OPENID_NS, 'contact');
+ $reference = $message->getArg(Auth_OpenID_OPENID_NS, 'reference');
+
+ return new Auth_OpenID_FailureResponse($endpoint, $error,
+ $contact, $reference);
+ }
+
+ /**
+ * @access private
+ */
+ function _complete_setup_needed($message, $endpoint, $unused)
+ {
+ if (!$message->isOpenID2()) {
+ return $this->_completeInvalid($message, $endpoint);
+ }
+
+ $user_setup_url = $message->getArg(Auth_OpenID_OPENID2_NS,
+ 'user_setup_url');
+ return new Auth_OpenID_SetupNeededResponse($endpoint, $user_setup_url);
+ }
+
+ /**
+ * @access private
+ */
+ function _complete_id_res($message, $endpoint, $return_to)
+ {
+ $user_setup_url = $message->getArg(Auth_OpenID_OPENID1_NS,
+ 'user_setup_url');
+
+ if ($this->_checkSetupNeeded($message)) {
+ return new Auth_OpenID_SetupNeededResponse(
+ $endpoint, $user_setup_url);
+ } else {
+ return $this->_doIdRes($message, $endpoint, $return_to);
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _checkSetupNeeded($message)
+ {
+ // In OpenID 1, we check to see if this is a cancel from
+ // immediate mode by the presence of the user_setup_url
+ // parameter.
+ if ($message->isOpenID1()) {
+ $user_setup_url = $message->getArg(Auth_OpenID_OPENID1_NS,
+ 'user_setup_url');
+ if ($user_setup_url !== null) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * @access private
+ */
+ function _doIdRes($message, $endpoint, $return_to)
+ {
+ // Checks for presence of appropriate fields (and checks
+ // signed list fields)
+ $result = $this->_idResCheckForFields($message);
+
+ if (Auth_OpenID::isFailure($result)) {
+ return $result;
+ }
+
+ if (!$this->_checkReturnTo($message, $return_to)) {
+ return new Auth_OpenID_FailureResponse(null,
+ sprintf("return_to does not match return URL. Expected %s, got %s",
+ $return_to,
+ $message->getArg(Auth_OpenID_OPENID_NS, 'return_to')));
+ }
+
+ // Verify discovery information:
+ $result = $this->_verifyDiscoveryResults($message, $endpoint);
+
+ if (Auth_OpenID::isFailure($result)) {
+ return $result;
+ }
+
+ $endpoint = $result;
+
+ $result = $this->_idResCheckSignature($message,
+ $endpoint->server_url);
+
+ if (Auth_OpenID::isFailure($result)) {
+ return $result;
+ }
+
+ $result = $this->_idResCheckNonce($message, $endpoint);
+
+ if (Auth_OpenID::isFailure($result)) {
+ return $result;
+ }
+
+ $signed_list_str = $message->getArg(Auth_OpenID_OPENID_NS, 'signed',
+ Auth_OpenID_NO_DEFAULT);
+ if (Auth_OpenID::isFailure($signed_list_str)) {
+ return $signed_list_str;
+ }
+ $signed_list = explode(',', $signed_list_str);
+
+ $signed_fields = Auth_OpenID::addPrefix($signed_list, "openid.");
+
+ return new Auth_OpenID_SuccessResponse($endpoint, $message,
+ $signed_fields);
+
+ }
+
+ /**
+ * @access private
+ */
+ function _checkReturnTo($message, $return_to)
+ {
+ // Check an OpenID message and its openid.return_to value
+ // against a return_to URL from an application. Return True
+ // on success, False on failure.
+
+ // Check the openid.return_to args against args in the
+ // original message.
+ $result = Auth_OpenID_GenericConsumer::_verifyReturnToArgs(
+ $message->toPostArgs());
+ if (Auth_OpenID::isFailure($result)) {
+ return false;
+ }
+
+ // Check the return_to base URL against the one in the
+ // message.
+ $msg_return_to = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'return_to');
+ if (Auth_OpenID::isFailure($return_to)) {
+ // XXX log me
+ return false;
+ }
+
+ $return_to_parts = parse_url(Auth_OpenID_urinorm($return_to));
+ $msg_return_to_parts = parse_url(Auth_OpenID_urinorm($msg_return_to));
+
+ // If port is absent from both, add it so it's equal in the
+ // check below.
+ if ((!array_key_exists('port', $return_to_parts)) &&
+ (!array_key_exists('port', $msg_return_to_parts))) {
+ $return_to_parts['port'] = null;
+ $msg_return_to_parts['port'] = null;
+ }
+
+ // If path is absent from both, add it so it's equal in the
+ // check below.
+ if ((!array_key_exists('path', $return_to_parts)) &&
+ (!array_key_exists('path', $msg_return_to_parts))) {
+ $return_to_parts['path'] = null;
+ $msg_return_to_parts['path'] = null;
+ }
+
+ // The URL scheme, authority, and path MUST be the same
+ // between the two URLs.
+ foreach (array('scheme', 'host', 'port', 'path') as $component) {
+ // If the url component is absent in either URL, fail.
+ // There should always be a scheme, host, port, and path.
+ if (!array_key_exists($component, $return_to_parts)) {
+ return false;
+ }
+
+ if (!array_key_exists($component, $msg_return_to_parts)) {
+ return false;
+ }
+
+ if (Auth_OpenID::arrayGet($return_to_parts, $component) !==
+ Auth_OpenID::arrayGet($msg_return_to_parts, $component)) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * @access private
+ */
+ function _verifyReturnToArgs($query)
+ {
+ // Verify that the arguments in the return_to URL are present in this
+ // response.
+
+ $message = Auth_OpenID_Message::fromPostArgs($query);
+ $return_to = $message->getArg(Auth_OpenID_OPENID_NS, 'return_to');
+
+ if (Auth_OpenID::isFailure($return_to)) {
+ return $return_to;
+ }
+ // XXX: this should be checked by _idResCheckForFields
+ if (!$return_to) {
+ return new Auth_OpenID_FailureResponse(null,
+ "Response has no return_to");
+ }
+
+ $parsed_url = parse_url($return_to);
+
+ $q = array();
+ if (array_key_exists('query', $parsed_url)) {
+ $rt_query = $parsed_url['query'];
+ $q = Auth_OpenID::parse_str($rt_query);
+ }
+
+ foreach ($q as $rt_key => $rt_value) {
+ if (!array_key_exists($rt_key, $query)) {
+ return new Auth_OpenID_FailureResponse(null,
+ sprintf("return_to parameter %s absent from query", $rt_key));
+ } else {
+ $value = $query[$rt_key];
+ if ($rt_value != $value) {
+ return new Auth_OpenID_FailureResponse(null,
+ sprintf("parameter %s value %s does not match " .
+ "return_to value %s", $rt_key,
+ $value, $rt_value));
+ }
+ }
+ }
+
+ // Make sure all non-OpenID arguments in the response are also
+ // in the signed return_to.
+ $bare_args = $message->getArgs(Auth_OpenID_BARE_NS);
+ foreach ($bare_args as $key => $value) {
+ if (Auth_OpenID::arrayGet($q, $key) != $value) {
+ return new Auth_OpenID_FailureResponse(null,
+ sprintf("Parameter %s = %s not in return_to URL",
+ $key, $value));
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * @access private
+ */
+ function _idResCheckSignature($message, $server_url)
+ {
+ $assoc_handle = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'assoc_handle');
+ if (Auth_OpenID::isFailure($assoc_handle)) {
+ return $assoc_handle;
+ }
+
+ $assoc = $this->store->getAssociation($server_url, $assoc_handle);
+
+ if ($assoc) {
+ if ($assoc->getExpiresIn() <= 0) {
+ // XXX: It might be a good idea sometimes to re-start
+ // the authentication with a new association. Doing it
+ // automatically opens the possibility for
+ // denial-of-service by a server that just returns
+ // expired associations (or really short-lived
+ // associations)
+ return new Auth_OpenID_FailureResponse(null,
+ 'Association with ' . $server_url . ' expired');
+ }
+
+ if (!$assoc->checkMessageSignature($message)) {
+ // If we get a "bad signature" here, it means that the association
+ // is unrecoverabley corrupted in some way. Any futher attempts
+ // to login with this association is likely to fail. Drop it.
+ $this->store->removeAssociation($server_url, $assoc_handle);
+ return new Auth_OpenID_FailureResponse(null,
+ "Bad signature");
+ }
+ } else {
+ // It's not an association we know about. Stateless mode
+ // is our only possible path for recovery. XXX - async
+ // framework will not want to block on this call to
+ // _checkAuth.
+ if (!$this->_checkAuth($message, $server_url)) {
+ return new Auth_OpenID_FailureResponse(null,
+ "Server denied check_authentication");
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * @access private
+ */
+ function _verifyDiscoveryResults($message, $endpoint=null)
+ {
+ if ($message->getOpenIDNamespace() == Auth_OpenID_OPENID2_NS) {
+ return $this->_verifyDiscoveryResultsOpenID2($message,
+ $endpoint);
+ } else {
+ return $this->_verifyDiscoveryResultsOpenID1($message,
+ $endpoint);
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _verifyDiscoveryResultsOpenID1($message, $endpoint)
+ {
+ $claimed_id = $message->getArg(Auth_OpenID_BARE_NS,
+ $this->openid1_return_to_identifier_name);
+
+ if (($endpoint === null) && ($claimed_id === null)) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ 'When using OpenID 1, the claimed ID must be supplied, ' .
+ 'either by passing it through as a return_to parameter ' .
+ 'or by using a session, and supplied to the GenericConsumer ' .
+ 'as the argument to complete()');
+ } else if (($endpoint !== null) && ($claimed_id === null)) {
+ $claimed_id = $endpoint->claimed_id;
+ }
+
+ $to_match = new Auth_OpenID_ServiceEndpoint();
+ $to_match->type_uris = array(Auth_OpenID_TYPE_1_1);
+ $to_match->local_id = $message->getArg(Auth_OpenID_OPENID1_NS,
+ 'identity');
+
+ // Restore delegate information from the initiation phase
+ $to_match->claimed_id = $claimed_id;
+
+ if ($to_match->local_id === null) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ "Missing required field openid.identity");
+ }
+
+ $to_match_1_0 = $to_match->copy();
+ $to_match_1_0->type_uris = array(Auth_OpenID_TYPE_1_0);
+
+ if ($endpoint !== null) {
+ $result = $this->_verifyDiscoverySingle($endpoint, $to_match);
+
+ if (is_a($result, 'Auth_OpenID_TypeURIMismatch')) {
+ $result = $this->_verifyDiscoverySingle($endpoint,
+ $to_match_1_0);
+ }
+
+ if (Auth_OpenID::isFailure($result)) {
+ // oidutil.log("Error attempting to use stored
+ // discovery information: " + str(e))
+ // oidutil.log("Attempting discovery to
+ // verify endpoint")
+ } else {
+ return $endpoint;
+ }
+ }
+
+ // Endpoint is either bad (failed verification) or None
+ return $this->_discoverAndVerify($to_match->claimed_id,
+ array($to_match, $to_match_1_0));
+ }
+
+ /**
+ * @access private
+ */
+ function _verifyDiscoverySingle($endpoint, $to_match)
+ {
+ // Every type URI that's in the to_match endpoint has to be
+ // present in the discovered endpoint.
+ foreach ($to_match->type_uris as $type_uri) {
+ if (!$endpoint->usesExtension($type_uri)) {
+ return new Auth_OpenID_TypeURIMismatch($endpoint,
+ "Required type ".$type_uri." not present");
+ }
+ }
+
+ // Fragments do not influence discovery, so we can't compare a
+ // claimed identifier with a fragment to discovered
+ // information.
+ list($defragged_claimed_id, $_) =
+ Auth_OpenID::urldefrag($to_match->claimed_id);
+
+ if ($defragged_claimed_id != $endpoint->claimed_id) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ sprintf('Claimed ID does not match (different subjects!), ' .
+ 'Expected %s, got %s', $defragged_claimed_id,
+ $endpoint->claimed_id));
+ }
+
+ if ($to_match->getLocalID() != $endpoint->getLocalID()) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ sprintf('local_id mismatch. Expected %s, got %s',
+ $to_match->getLocalID(), $endpoint->getLocalID()));
+ }
+
+ // If the server URL is None, this must be an OpenID 1
+ // response, because op_endpoint is a required parameter in
+ // OpenID 2. In that case, we don't actually care what the
+ // discovered server_url is, because signature checking or
+ // check_auth should take care of that check for us.
+ if ($to_match->server_url === null) {
+ if ($to_match->preferredNamespace() != Auth_OpenID_OPENID1_NS) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ "Preferred namespace mismatch (bug)");
+ }
+ } else if ($to_match->server_url != $endpoint->server_url) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ sprintf('OP Endpoint mismatch. Expected %s, got %s',
+ $to_match->server_url, $endpoint->server_url));
+ }
+
+ return null;
+ }
+
+ /**
+ * @access private
+ */
+ function _verifyDiscoveryResultsOpenID2($message, $endpoint)
+ {
+ $to_match = new Auth_OpenID_ServiceEndpoint();
+ $to_match->type_uris = array(Auth_OpenID_TYPE_2_0);
+ $to_match->claimed_id = $message->getArg(Auth_OpenID_OPENID2_NS,
+ 'claimed_id');
+
+ $to_match->local_id = $message->getArg(Auth_OpenID_OPENID2_NS,
+ 'identity');
+
+ $to_match->server_url = $message->getArg(Auth_OpenID_OPENID2_NS,
+ 'op_endpoint');
+
+ if ($to_match->server_url === null) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ "OP Endpoint URL missing");
+ }
+
+ // claimed_id and identifier must both be present or both be
+ // absent
+ if (($to_match->claimed_id === null) &&
+ ($to_match->local_id !== null)) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ 'openid.identity is present without openid.claimed_id');
+ }
+
+ if (($to_match->claimed_id !== null) &&
+ ($to_match->local_id === null)) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ 'openid.claimed_id is present without openid.identity');
+ }
+
+ if ($to_match->claimed_id === null) {
+ // This is a response without identifiers, so there's
+ // really no checking that we can do, so return an
+ // endpoint that's for the specified `openid.op_endpoint'
+ return Auth_OpenID_ServiceEndpoint::fromOPEndpointURL(
+ $to_match->server_url);
+ }
+
+ if (!$endpoint) {
+ // The claimed ID doesn't match, so we have to do
+ // discovery again. This covers not using sessions, OP
+ // identifier endpoints and responses that didn't match
+ // the original request.
+ // oidutil.log('No pre-discovered information supplied.')
+ return $this->_discoverAndVerify($to_match->claimed_id,
+ array($to_match));
+ } else {
+
+ // The claimed ID matches, so we use the endpoint that we
+ // discovered in initiation. This should be the most
+ // common case.
+ $result = $this->_verifyDiscoverySingle($endpoint, $to_match);
+
+ if (Auth_OpenID::isFailure($result)) {
+ $endpoint = $this->_discoverAndVerify($to_match->claimed_id,
+ array($to_match));
+ if (Auth_OpenID::isFailure($endpoint)) {
+ return $endpoint;
+ }
+ }
+ }
+
+ // The endpoint we return should have the claimed ID from the
+ // message we just verified, fragment and all.
+ if ($endpoint->claimed_id != $to_match->claimed_id) {
+ $endpoint->claimed_id = $to_match->claimed_id;
+ }
+
+ return $endpoint;
+ }
+
+ /**
+ * @access private
+ */
+ function _discoverAndVerify($claimed_id, $to_match_endpoints)
+ {
+ // oidutil.log('Performing discovery on %s' % (claimed_id,))
+ list($unused, $services) = call_user_func($this->discoverMethod,
+ $claimed_id,
+ &$this->fetcher);
+
+ if (!$services) {
+ return new Auth_OpenID_FailureResponse(null,
+ sprintf("No OpenID information found at %s",
+ $claimed_id));
+ }
+
+ return $this->_verifyDiscoveryServices($claimed_id, $services,
+ $to_match_endpoints);
+ }
+
+ /**
+ * @access private
+ */
+ function _verifyDiscoveryServices($claimed_id,
+ $services, $to_match_endpoints)
+ {
+ // Search the services resulting from discovery to find one
+ // that matches the information from the assertion
+
+ foreach ($services as $endpoint) {
+ foreach ($to_match_endpoints as $to_match_endpoint) {
+ $result = $this->_verifyDiscoverySingle($endpoint,
+ $to_match_endpoint);
+
+ if (!Auth_OpenID::isFailure($result)) {
+ // It matches, so discover verification has
+ // succeeded. Return this endpoint.
+ return $endpoint;
+ }
+ }
+ }
+
+ return new Auth_OpenID_FailureResponse(null,
+ sprintf('No matching endpoint found after discovering %s: %s',
+ $claimed_id, $result->message));
+ }
+
+ /**
+ * Extract the nonce from an OpenID 1 response. Return the nonce
+ * from the BARE_NS since we independently check the return_to
+ * arguments are the same as those in the response message.
+ *
+ * See the openid1_nonce_query_arg_name class variable
+ *
+ * @returns $nonce The nonce as a string or null
+ *
+ * @access private
+ */
+ function _idResGetNonceOpenID1($message, $endpoint)
+ {
+ return $message->getArg(Auth_OpenID_BARE_NS,
+ $this->openid1_nonce_query_arg_name);
+ }
+
+ /**
+ * @access private
+ */
+ function _idResCheckNonce($message, $endpoint)
+ {
+ if ($message->isOpenID1()) {
+ // This indicates that the nonce was generated by the consumer
+ $nonce = $this->_idResGetNonceOpenID1($message, $endpoint);
+ $server_url = '';
+ } else {
+ $nonce = $message->getArg(Auth_OpenID_OPENID2_NS,
+ 'response_nonce');
+
+ $server_url = $endpoint->server_url;
+ }
+
+ if ($nonce === null) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ "Nonce missing from response");
+ }
+
+ $parts = Auth_OpenID_splitNonce($nonce);
+
+ if ($parts === null) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ "Malformed nonce in response");
+ }
+
+ list($timestamp, $salt) = $parts;
+
+ if (!$this->store->useNonce($server_url, $timestamp, $salt)) {
+ return new Auth_OpenID_FailureResponse($endpoint,
+ "Nonce already used or out of range");
+ }
+
+ return null;
+ }
+
+ /**
+ * @access private
+ */
+ function _idResCheckForFields($message)
+ {
+ $basic_fields = array('return_to', 'assoc_handle', 'sig', 'signed');
+ $basic_sig_fields = array('return_to', 'identity');
+
+ $require_fields = array(
+ Auth_OpenID_OPENID2_NS => array_merge($basic_fields,
+ array('op_endpoint')),
+
+ Auth_OpenID_OPENID1_NS => array_merge($basic_fields,
+ array('identity'))
+ );
+
+ $require_sigs = array(
+ Auth_OpenID_OPENID2_NS => array_merge($basic_sig_fields,
+ array('response_nonce',
+ 'claimed_id',
+ 'assoc_handle',
+ 'op_endpoint')),
+ Auth_OpenID_OPENID1_NS => array_merge($basic_sig_fields,
+ array('nonce'))
+ );
+
+ foreach ($require_fields[$message->getOpenIDNamespace()] as $field) {
+ if (!$message->hasKey(Auth_OpenID_OPENID_NS, $field)) {
+ return new Auth_OpenID_FailureResponse(null,
+ "Missing required field '".$field."'");
+ }
+ }
+
+ $signed_list_str = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'signed',
+ Auth_OpenID_NO_DEFAULT);
+ if (Auth_OpenID::isFailure($signed_list_str)) {
+ return $signed_list_str;
+ }
+ $signed_list = explode(',', $signed_list_str);
+
+ foreach ($require_sigs[$message->getOpenIDNamespace()] as $field) {
+ // Field is present and not in signed list
+ if ($message->hasKey(Auth_OpenID_OPENID_NS, $field) &&
+ (!in_array($field, $signed_list))) {
+ return new Auth_OpenID_FailureResponse(null,
+ "'".$field."' not signed");
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * @access private
+ */
+ function _checkAuth($message, $server_url)
+ {
+ $request = $this->_createCheckAuthRequest($message);
+ if ($request === null) {
+ return false;
+ }
+
+ $resp_message = $this->_makeKVPost($request, $server_url);
+ if (($resp_message === null) ||
+ (is_a($resp_message, 'Auth_OpenID_ServerErrorContainer'))) {
+ return false;
+ }
+
+ return $this->_processCheckAuthResponse($resp_message, $server_url);
+ }
+
+ /**
+ * @access private
+ */
+ function _createCheckAuthRequest($message)
+ {
+ $signed = $message->getArg(Auth_OpenID_OPENID_NS, 'signed');
+ if ($signed) {
+ foreach (explode(',', $signed) as $k) {
+ $value = $message->getAliasedArg($k);
+ if ($value === null) {
+ return null;
+ }
+ }
+ }
+ $ca_message = $message->copy();
+ $ca_message->setArg(Auth_OpenID_OPENID_NS, 'mode',
+ 'check_authentication');
+ return $ca_message;
+ }
+
+ /**
+ * @access private
+ */
+ function _processCheckAuthResponse($response, $server_url)
+ {
+ $is_valid = $response->getArg(Auth_OpenID_OPENID_NS, 'is_valid',
+ 'false');
+
+ $invalidate_handle = $response->getArg(Auth_OpenID_OPENID_NS,
+ 'invalidate_handle');
+
+ if ($invalidate_handle !== null) {
+ $this->store->removeAssociation($server_url,
+ $invalidate_handle);
+ }
+
+ if ($is_valid == 'true') {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Adapt a POST response to a Message.
+ *
+ * @param $response Result of a POST to an OpenID endpoint.
+ *
+ * @access private
+ */
+ static function _httpResponseToMessage($response, $server_url)
+ {
+ // Should this function be named Message.fromHTTPResponse instead?
+ $response_message = Auth_OpenID_Message::fromKVForm($response->body);
+
+ if ($response->status == 400) {
+ return Auth_OpenID_ServerErrorContainer::fromMessage(
+ $response_message);
+ } else if ($response->status != 200 and $response->status != 206) {
+ return null;
+ }
+
+ return $response_message;
+ }
+
+ /**
+ * @access private
+ */
+ function _makeKVPost($message, $server_url)
+ {
+ $body = $message->toURLEncoded();
+ $resp = $this->fetcher->post($server_url, $body);
+
+ if ($resp === null) {
+ return null;
+ }
+
+ return $this->_httpResponseToMessage($resp, $server_url);
+ }
+
+ /**
+ * @access private
+ */
+ function _getAssociation($endpoint)
+ {
+ if (!$this->_use_assocs) {
+ return null;
+ }
+
+ $assoc = $this->store->getAssociation($endpoint->server_url);
+
+ if (($assoc === null) ||
+ ($assoc->getExpiresIn() <= 0)) {
+
+ $assoc = $this->_negotiateAssociation($endpoint);
+
+ if ($assoc !== null) {
+ $this->store->storeAssociation($endpoint->server_url,
+ $assoc);
+ }
+ }
+
+ return $assoc;
+ }
+
+ /**
+ * Handle ServerErrors resulting from association requests.
+ *
+ * @return $result If server replied with an C{unsupported-type}
+ * error, return a tuple of supported C{association_type},
+ * C{session_type}. Otherwise logs the error and returns null.
+ *
+ * @access private
+ */
+ function _extractSupportedAssociationType($server_error, $endpoint,
+ $assoc_type)
+ {
+ // Any error message whose code is not 'unsupported-type'
+ // should be considered a total failure.
+ if (($server_error->error_code != 'unsupported-type') ||
+ ($server_error->message->isOpenID1())) {
+ return null;
+ }
+
+ // The server didn't like the association/session type that we
+ // sent, and it sent us back a message that might tell us how
+ // to handle it.
+
+ // Extract the session_type and assoc_type from the error
+ // message
+ $assoc_type = $server_error->message->getArg(Auth_OpenID_OPENID_NS,
+ 'assoc_type');
+
+ $session_type = $server_error->message->getArg(Auth_OpenID_OPENID_NS,
+ 'session_type');
+
+ if (($assoc_type === null) || ($session_type === null)) {
+ return null;
+ } else if (!$this->negotiator->isAllowed($assoc_type,
+ $session_type)) {
+ return null;
+ } else {
+ return array($assoc_type, $session_type);
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _negotiateAssociation($endpoint)
+ {
+ // Get our preferred session/association type from the negotiatior.
+ list($assoc_type, $session_type) = $this->negotiator->getAllowedType();
+
+ $assoc = $this->_requestAssociation(
+ $endpoint, $assoc_type, $session_type);
+
+ if (Auth_OpenID::isFailure($assoc)) {
+ return null;
+ }
+
+ if (is_a($assoc, 'Auth_OpenID_ServerErrorContainer')) {
+ $why = $assoc;
+
+ $supportedTypes = $this->_extractSupportedAssociationType(
+ $why, $endpoint, $assoc_type);
+
+ if ($supportedTypes !== null) {
+ list($assoc_type, $session_type) = $supportedTypes;
+
+ // Attempt to create an association from the assoc_type
+ // and session_type that the server told us it
+ // supported.
+ $assoc = $this->_requestAssociation(
+ $endpoint, $assoc_type, $session_type);
+
+ if (is_a($assoc, 'Auth_OpenID_ServerErrorContainer')) {
+ // Do not keep trying, since it rejected the
+ // association type that it told us to use.
+ // oidutil.log('Server %s refused its suggested association
+ // 'type: session_type=%s, assoc_type=%s'
+ // % (endpoint.server_url, session_type,
+ // assoc_type))
+ return null;
+ } else {
+ return $assoc;
+ }
+ } else {
+ return null;
+ }
+ } else {
+ return $assoc;
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _requestAssociation($endpoint, $assoc_type, $session_type)
+ {
+ list($assoc_session, $args) = $this->_createAssociateRequest(
+ $endpoint, $assoc_type, $session_type);
+
+ $response_message = $this->_makeKVPost($args, $endpoint->server_url);
+
+ if ($response_message === null) {
+ // oidutil.log('openid.associate request failed: %s' % (why[0],))
+ return null;
+ } else if (is_a($response_message,
+ 'Auth_OpenID_ServerErrorContainer')) {
+ return $response_message;
+ }
+
+ return $this->_extractAssociation($response_message, $assoc_session);
+ }
+
+ /**
+ * @access private
+ */
+ function _extractAssociation($assoc_response, $assoc_session)
+ {
+ // Extract the common fields from the response, raising an
+ // exception if they are not found
+ $assoc_type = $assoc_response->getArg(
+ Auth_OpenID_OPENID_NS, 'assoc_type',
+ Auth_OpenID_NO_DEFAULT);
+
+ if (Auth_OpenID::isFailure($assoc_type)) {
+ return $assoc_type;
+ }
+
+ $assoc_handle = $assoc_response->getArg(
+ Auth_OpenID_OPENID_NS, 'assoc_handle',
+ Auth_OpenID_NO_DEFAULT);
+
+ if (Auth_OpenID::isFailure($assoc_handle)) {
+ return $assoc_handle;
+ }
+
+ // expires_in is a base-10 string. The Python parsing will
+ // accept literals that have whitespace around them and will
+ // accept negative values. Neither of these are really in-spec,
+ // but we think it's OK to accept them.
+ $expires_in_str = $assoc_response->getArg(
+ Auth_OpenID_OPENID_NS, 'expires_in',
+ Auth_OpenID_NO_DEFAULT);
+
+ if (Auth_OpenID::isFailure($expires_in_str)) {
+ return $expires_in_str;
+ }
+
+ $expires_in = Auth_OpenID::intval($expires_in_str);
+ if ($expires_in === false) {
+
+ $err = sprintf("Could not parse expires_in from association ".
+ "response %s", print_r($assoc_response, true));
+ return new Auth_OpenID_FailureResponse(null, $err);
+ }
+
+ // OpenID 1 has funny association session behaviour.
+ if ($assoc_response->isOpenID1()) {
+ $session_type = $this->_getOpenID1SessionType($assoc_response);
+ } else {
+ $session_type = $assoc_response->getArg(
+ Auth_OpenID_OPENID2_NS, 'session_type',
+ Auth_OpenID_NO_DEFAULT);
+
+ if (Auth_OpenID::isFailure($session_type)) {
+ return $session_type;
+ }
+ }
+
+ // Session type mismatch
+ if ($assoc_session->session_type != $session_type) {
+ if ($assoc_response->isOpenID1() &&
+ ($session_type == 'no-encryption')) {
+ // In OpenID 1, any association request can result in
+ // a 'no-encryption' association response. Setting
+ // assoc_session to a new no-encryption session should
+ // make the rest of this function work properly for
+ // that case.
+ $assoc_session = new Auth_OpenID_PlainTextConsumerSession();
+ } else {
+ // Any other mismatch, regardless of protocol version
+ // results in the failure of the association session
+ // altogether.
+ return null;
+ }
+ }
+
+ // Make sure assoc_type is valid for session_type
+ if (!in_array($assoc_type, $assoc_session->allowed_assoc_types)) {
+ return null;
+ }
+
+ // Delegate to the association session to extract the secret
+ // from the response, however is appropriate for that session
+ // type.
+ $secret = $assoc_session->extractSecret($assoc_response);
+
+ if ($secret === null) {
+ return null;
+ }
+
+ return Auth_OpenID_Association::fromExpiresIn(
+ $expires_in, $assoc_handle, $secret, $assoc_type);
+ }
+
+ /**
+ * @access private
+ */
+ function _createAssociateRequest($endpoint, $assoc_type, $session_type)
+ {
+ if (array_key_exists($session_type, $this->session_types)) {
+ $session_type_class = $this->session_types[$session_type];
+
+ if (is_callable($session_type_class)) {
+ $assoc_session = $session_type_class();
+ } else {
+ $assoc_session = new $session_type_class();
+ }
+ } else {
+ return null;
+ }
+
+ $args = array(
+ 'mode' => 'associate',
+ 'assoc_type' => $assoc_type);
+
+ if (!$endpoint->compatibilityMode()) {
+ $args['ns'] = Auth_OpenID_OPENID2_NS;
+ }
+
+ // Leave out the session type if we're in compatibility mode
+ // *and* it's no-encryption.
+ if ((!$endpoint->compatibilityMode()) ||
+ ($assoc_session->session_type != 'no-encryption')) {
+ $args['session_type'] = $assoc_session->session_type;
+ }
+
+ $args = array_merge($args, $assoc_session->getRequest());
+ $message = Auth_OpenID_Message::fromOpenIDArgs($args);
+ return array($assoc_session, $message);
+ }
+
+ /**
+ * Given an association response message, extract the OpenID 1.X
+ * session type.
+ *
+ * This function mostly takes care of the 'no-encryption' default
+ * behavior in OpenID 1.
+ *
+ * If the association type is plain-text, this function will
+ * return 'no-encryption'
+ *
+ * @access private
+ * @return $typ The association type for this message
+ */
+ function _getOpenID1SessionType($assoc_response)
+ {
+ // If it's an OpenID 1 message, allow session_type to default
+ // to None (which signifies "no-encryption")
+ $session_type = $assoc_response->getArg(Auth_OpenID_OPENID1_NS,
+ 'session_type');
+
+ // Handle the differences between no-encryption association
+ // respones in OpenID 1 and 2:
+
+ // no-encryption is not really a valid session type for OpenID
+ // 1, but we'll accept it anyway, while issuing a warning.
+ if ($session_type == 'no-encryption') {
+ // oidutil.log('WARNING: OpenID server sent "no-encryption"'
+ // 'for OpenID 1.X')
+ } else if (($session_type == '') || ($session_type === null)) {
+ // Missing or empty session type is the way to flag a
+ // 'no-encryption' response. Change the session type to
+ // 'no-encryption' so that it can be handled in the same
+ // way as OpenID 2 'no-encryption' respones.
+ $session_type = 'no-encryption';
+ }
+
+ return $session_type;
+ }
+}
+
+/**
+ * This class represents an authentication request from a consumer to
+ * an OpenID server.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AuthRequest {
+
+ /**
+ * Initialize an authentication request with the specified token,
+ * association, and endpoint.
+ *
+ * Users of this library should not create instances of this
+ * class. Instances of this class are created by the library when
+ * needed.
+ */
+ function Auth_OpenID_AuthRequest($endpoint, $assoc)
+ {
+ $this->assoc = $assoc;
+ $this->endpoint = $endpoint;
+ $this->return_to_args = array();
+ $this->message = new Auth_OpenID_Message(
+ $endpoint->preferredNamespace());
+ $this->_anonymous = false;
+ }
+
+ /**
+ * Add an extension to this checkid request.
+ *
+ * $extension_request: An object that implements the extension
+ * request interface for adding arguments to an OpenID message.
+ */
+ function addExtension($extension_request)
+ {
+ $extension_request->toMessage($this->message);
+ }
+
+ /**
+ * Add an extension argument to this OpenID authentication
+ * request.
+ *
+ * Use caution when adding arguments, because they will be
+ * URL-escaped and appended to the redirect URL, which can easily
+ * get quite long.
+ *
+ * @param string $namespace The namespace for the extension. For
+ * example, the simple registration extension uses the namespace
+ * 'sreg'.
+ *
+ * @param string $key The key within the extension namespace. For
+ * example, the nickname field in the simple registration
+ * extension's key is 'nickname'.
+ *
+ * @param string $value The value to provide to the server for
+ * this argument.
+ */
+ function addExtensionArg($namespace, $key, $value)
+ {
+ return $this->message->setArg($namespace, $key, $value);
+ }
+
+ /**
+ * Set whether this request should be made anonymously. If a
+ * request is anonymous, the identifier will not be sent in the
+ * request. This is only useful if you are making another kind of
+ * request with an extension in this request.
+ *
+ * Anonymous requests are not allowed when the request is made
+ * with OpenID 1.
+ */
+ function setAnonymous($is_anonymous)
+ {
+ if ($is_anonymous && $this->message->isOpenID1()) {
+ return false;
+ } else {
+ $this->_anonymous = $is_anonymous;
+ return true;
+ }
+ }
+
+ /**
+ * Produce a {@link Auth_OpenID_Message} representing this
+ * request.
+ *
+ * @param string $realm The URL (or URL pattern) that identifies
+ * your web site to the user when she is authorizing it.
+ *
+ * @param string $return_to The URL that the OpenID provider will
+ * send the user back to after attempting to verify her identity.
+ *
+ * Not specifying a return_to URL means that the user will not be
+ * returned to the site issuing the request upon its completion.
+ *
+ * @param bool $immediate If true, the OpenID provider is to send
+ * back a response immediately, useful for behind-the-scenes
+ * authentication attempts. Otherwise the OpenID provider may
+ * engage the user before providing a response. This is the
+ * default case, as the user may need to provide credentials or
+ * approve the request before a positive response can be sent.
+ */
+ function getMessage($realm, $return_to=null, $immediate=false)
+ {
+ if ($return_to) {
+ $return_to = Auth_OpenID::appendArgs($return_to,
+ $this->return_to_args);
+ } else if ($immediate) {
+ // raise ValueError(
+ // '"return_to" is mandatory when
+ //using "checkid_immediate"')
+ return new Auth_OpenID_FailureResponse(null,
+ "'return_to' is mandatory when using checkid_immediate");
+ } else if ($this->message->isOpenID1()) {
+ // raise ValueError('"return_to" is
+ // mandatory for OpenID 1 requests')
+ return new Auth_OpenID_FailureResponse(null,
+ "'return_to' is mandatory for OpenID 1 requests");
+ } else if ($this->return_to_args) {
+ // raise ValueError('extra "return_to" arguments
+ // were specified, but no return_to was specified')
+ return new Auth_OpenID_FailureResponse(null,
+ "extra 'return_to' arguments where specified, " .
+ "but no return_to was specified");
+ }
+
+ if ($immediate) {
+ $mode = 'checkid_immediate';
+ } else {
+ $mode = 'checkid_setup';
+ }
+
+ $message = $this->message->copy();
+ if ($message->isOpenID1()) {
+ $realm_key = 'trust_root';
+ } else {
+ $realm_key = 'realm';
+ }
+
+ $message->updateArgs(Auth_OpenID_OPENID_NS,
+ array(
+ $realm_key => $realm,
+ 'mode' => $mode,
+ 'return_to' => $return_to));
+
+ if (!$this->_anonymous) {
+ if ($this->endpoint->isOPIdentifier()) {
+ // This will never happen when we're in compatibility
+ // mode, as long as isOPIdentifier() returns False
+ // whenever preferredNamespace() returns OPENID1_NS.
+ $claimed_id = $request_identity =
+ Auth_OpenID_IDENTIFIER_SELECT;
+ } else {
+ $request_identity = $this->endpoint->getLocalID();
+ $claimed_id = $this->endpoint->claimed_id;
+ }
+
+ // This is true for both OpenID 1 and 2
+ $message->setArg(Auth_OpenID_OPENID_NS, 'identity',
+ $request_identity);
+
+ if ($message->isOpenID2()) {
+ $message->setArg(Auth_OpenID_OPENID2_NS, 'claimed_id',
+ $claimed_id);
+ }
+ }
+
+ if ($this->assoc) {
+ $message->setArg(Auth_OpenID_OPENID_NS, 'assoc_handle',
+ $this->assoc->handle);
+ }
+
+ return $message;
+ }
+
+ function redirectURL($realm, $return_to = null,
+ $immediate = false)
+ {
+ $message = $this->getMessage($realm, $return_to, $immediate);
+
+ if (Auth_OpenID::isFailure($message)) {
+ return $message;
+ }
+
+ return $message->toURL($this->endpoint->server_url);
+ }
+
+ /**
+ * Get html for a form to submit this request to the IDP.
+ *
+ * form_tag_attrs: An array of attributes to be added to the form
+ * tag. 'accept-charset' and 'enctype' have defaults that can be
+ * overridden. If a value is supplied for 'action' or 'method', it
+ * will be replaced.
+ */
+ function formMarkup($realm, $return_to=null, $immediate=false,
+ $form_tag_attrs=null)
+ {
+ $message = $this->getMessage($realm, $return_to, $immediate);
+
+ if (Auth_OpenID::isFailure($message)) {
+ return $message;
+ }
+
+ return $message->toFormMarkup($this->endpoint->server_url,
+ $form_tag_attrs);
+ }
+
+ /**
+ * Get a complete html document that will autosubmit the request
+ * to the IDP.
+ *
+ * Wraps formMarkup. See the documentation for that function.
+ */
+ function htmlMarkup($realm, $return_to=null, $immediate=false,
+ $form_tag_attrs=null)
+ {
+ $form = $this->formMarkup($realm, $return_to, $immediate,
+ $form_tag_attrs);
+
+ if (Auth_OpenID::isFailure($form)) {
+ return $form;
+ }
+ return Auth_OpenID::autoSubmitHTML($form);
+ }
+
+ function shouldSendRedirect()
+ {
+ return $this->endpoint->compatibilityMode();
+ }
+}
+
+/**
+ * The base class for responses from the Auth_OpenID_Consumer.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_ConsumerResponse {
+ var $status = null;
+
+ function setEndpoint($endpoint)
+ {
+ $this->endpoint = $endpoint;
+ if ($endpoint === null) {
+ $this->identity_url = null;
+ } else {
+ $this->identity_url = $endpoint->claimed_id;
+ }
+ }
+
+ /**
+ * Return the display identifier for this response.
+ *
+ * The display identifier is related to the Claimed Identifier, but the
+ * two are not always identical. The display identifier is something the
+ * user should recognize as what they entered, whereas the response's
+ * claimed identifier (in the identity_url attribute) may have extra
+ * information for better persistence.
+ *
+ * URLs will be stripped of their fragments for display. XRIs will
+ * display the human-readable identifier (i-name) instead of the
+ * persistent identifier (i-number).
+ *
+ * Use the display identifier in your user interface. Use
+ * identity_url for querying your database or authorization server.
+ *
+ */
+ function getDisplayIdentifier()
+ {
+ if ($this->endpoint !== null) {
+ return $this->endpoint->getDisplayIdentifier();
+ }
+ return null;
+ }
+}
+
+/**
+ * A response with a status of Auth_OpenID_SUCCESS. Indicates that
+ * this request is a successful acknowledgement from the OpenID server
+ * that the supplied URL is, indeed controlled by the requesting
+ * agent. This has three relevant attributes:
+ *
+ * claimed_id - The identity URL that has been authenticated
+ *
+ * signed_args - The arguments in the server's response that were
+ * signed and verified.
+ *
+ * status - Auth_OpenID_SUCCESS.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SuccessResponse extends Auth_OpenID_ConsumerResponse {
+ var $status = Auth_OpenID_SUCCESS;
+
+ /**
+ * @access private
+ */
+ function Auth_OpenID_SuccessResponse($endpoint, $message, $signed_args=null)
+ {
+ $this->endpoint = $endpoint;
+ $this->identity_url = $endpoint->claimed_id;
+ $this->signed_args = $signed_args;
+ $this->message = $message;
+
+ if ($this->signed_args === null) {
+ $this->signed_args = array();
+ }
+ }
+
+ /**
+ * Extract signed extension data from the server's response.
+ *
+ * @param string $prefix The extension namespace from which to
+ * extract the extension data.
+ */
+ function extensionResponse($namespace_uri, $require_signed)
+ {
+ if ($require_signed) {
+ return $this->getSignedNS($namespace_uri);
+ } else {
+ return $this->message->getArgs($namespace_uri);
+ }
+ }
+
+ function isOpenID1()
+ {
+ return $this->message->isOpenID1();
+ }
+
+ function isSigned($ns_uri, $ns_key)
+ {
+ // Return whether a particular key is signed, regardless of
+ // its namespace alias
+ return in_array($this->message->getKey($ns_uri, $ns_key),
+ $this->signed_args);
+ }
+
+ function getSigned($ns_uri, $ns_key, $default = null)
+ {
+ // Return the specified signed field if available, otherwise
+ // return default
+ if ($this->isSigned($ns_uri, $ns_key)) {
+ return $this->message->getArg($ns_uri, $ns_key, $default);
+ } else {
+ return $default;
+ }
+ }
+
+ function getSignedNS($ns_uri)
+ {
+ $args = array();
+
+ $msg_args = $this->message->getArgs($ns_uri);
+ if (Auth_OpenID::isFailure($msg_args)) {
+ return null;
+ }
+
+ foreach ($msg_args as $key => $value) {
+ if (!$this->isSigned($ns_uri, $key)) {
+ unset($msg_args[$key]);
+ }
+ }
+
+ return $msg_args;
+ }
+
+ /**
+ * Get the openid.return_to argument from this response.
+ *
+ * This is useful for verifying that this request was initiated by
+ * this consumer.
+ *
+ * @return string $return_to The return_to URL supplied to the
+ * server on the initial request, or null if the response did not
+ * contain an 'openid.return_to' argument.
+ */
+ function getReturnTo()
+ {
+ return $this->getSigned(Auth_OpenID_OPENID_NS, 'return_to');
+ }
+}
+
+/**
+ * A response with a status of Auth_OpenID_FAILURE. Indicates that the
+ * OpenID protocol has failed. This could be locally or remotely
+ * triggered. This has three relevant attributes:
+ *
+ * claimed_id - The identity URL for which authentication was
+ * attempted, if it can be determined. Otherwise, null.
+ *
+ * message - A message indicating why the request failed, if one is
+ * supplied. Otherwise, null.
+ *
+ * status - Auth_OpenID_FAILURE.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_FailureResponse extends Auth_OpenID_ConsumerResponse {
+ var $status = Auth_OpenID_FAILURE;
+
+ function Auth_OpenID_FailureResponse($endpoint, $message = null,
+ $contact = null, $reference = null)
+ {
+ $this->setEndpoint($endpoint);
+ $this->message = $message;
+ $this->contact = $contact;
+ $this->reference = $reference;
+ }
+}
+
+/**
+ * A specific, internal failure used to detect type URI mismatch.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_TypeURIMismatch extends Auth_OpenID_FailureResponse {
+}
+
+/**
+ * Exception that is raised when the server returns a 400 response
+ * code to a direct request.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_ServerErrorContainer {
+ function Auth_OpenID_ServerErrorContainer($error_text,
+ $error_code,
+ $message)
+ {
+ $this->error_text = $error_text;
+ $this->error_code = $error_code;
+ $this->message = $message;
+ }
+
+ /**
+ * @access private
+ */
+ static function fromMessage($message)
+ {
+ $error_text = $message->getArg(
+ Auth_OpenID_OPENID_NS, 'error', '<no error message supplied>');
+ $error_code = $message->getArg(Auth_OpenID_OPENID_NS, 'error_code');
+ return new Auth_OpenID_ServerErrorContainer($error_text,
+ $error_code,
+ $message);
+ }
+}
+
+/**
+ * A response with a status of Auth_OpenID_CANCEL. Indicates that the
+ * user cancelled the OpenID authentication request. This has two
+ * relevant attributes:
+ *
+ * claimed_id - The identity URL for which authentication was
+ * attempted, if it can be determined. Otherwise, null.
+ *
+ * status - Auth_OpenID_SUCCESS.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_CancelResponse extends Auth_OpenID_ConsumerResponse {
+ var $status = Auth_OpenID_CANCEL;
+
+ function Auth_OpenID_CancelResponse($endpoint)
+ {
+ $this->setEndpoint($endpoint);
+ }
+}
+
+/**
+ * A response with a status of Auth_OpenID_SETUP_NEEDED. Indicates
+ * that the request was in immediate mode, and the server is unable to
+ * authenticate the user without further interaction.
+ *
+ * claimed_id - The identity URL for which authentication was
+ * attempted.
+ *
+ * setup_url - A URL that can be used to send the user to the server
+ * to set up for authentication. The user should be redirected in to
+ * the setup_url, either in the current window or in a new browser
+ * window. Null in OpenID 2.
+ *
+ * status - Auth_OpenID_SETUP_NEEDED.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SetupNeededResponse extends Auth_OpenID_ConsumerResponse {
+ var $status = Auth_OpenID_SETUP_NEEDED;
+
+ function Auth_OpenID_SetupNeededResponse($endpoint,
+ $setup_url = null)
+ {
+ $this->setEndpoint($endpoint);
+ $this->setup_url = $setup_url;
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/CryptUtil.php
@@ -1,1 +1,123 @@
+<?php
+/**
+ * CryptUtil: A suite of wrapper utility functions for the OpenID
+ * library.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @access private
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+if (!defined('Auth_OpenID_RAND_SOURCE')) {
+ /**
+ * The filename for a source of random bytes. Define this yourself
+ * if you have a different source of randomness.
+ */
+ define('Auth_OpenID_RAND_SOURCE', '/dev/urandom');
+}
+
+class Auth_OpenID_CryptUtil {
+ /**
+ * Get the specified number of random bytes.
+ *
+ * Attempts to use a cryptographically secure (not predictable)
+ * source of randomness if available. If there is no high-entropy
+ * randomness source available, it will fail. As a last resort,
+ * for non-critical systems, define
+ * <code>Auth_OpenID_RAND_SOURCE</code> as <code>null</code>, and
+ * the code will fall back on a pseudo-random number generator.
+ *
+ * @param int $num_bytes The length of the return value
+ * @return string $bytes random bytes
+ */
+ static function getBytes($num_bytes)
+ {
+ static $f = null;
+ $bytes = '';
+ if ($f === null) {
+ if (Auth_OpenID_RAND_SOURCE === null) {
+ $f = false;
+ } else {
+ $f = @fopen(Auth_OpenID_RAND_SOURCE, "r");
+ /*if ($f === false) {
+ $msg = 'Define Auth_OpenID_RAND_SOURCE as null to ' .
+ ' continue with an insecure random number generator.';
+ trigger_error($msg, E_USER_ERROR);
+ }*/
+ }
+ }
+ if ($f === false) {
+ // pseudorandom used
+ $bytes = '';
+ for ($i = 0; $i < $num_bytes; $i += 4) {
+ $bytes .= pack('L', mt_rand());
+ }
+ $bytes = substr($bytes, 0, $num_bytes);
+ } else {
+ $bytes = fread($f, $num_bytes);
+ }
+ return $bytes;
+ }
+
+ /**
+ * Produce a string of length random bytes, chosen from chrs. If
+ * $chrs is null, the resulting string may contain any characters.
+ *
+ * @param integer $length The length of the resulting
+ * randomly-generated string
+ * @param string $chrs A string of characters from which to choose
+ * to build the new string
+ * @return string $result A string of randomly-chosen characters
+ * from $chrs
+ */
+ static function randomString($length, $population = null)
+ {
+ if ($population === null) {
+ return Auth_OpenID_CryptUtil::getBytes($length);
+ }
+
+ $popsize = strlen($population);
+
+ if ($popsize > 256) {
+ $msg = 'More than 256 characters supplied to ' . __FUNCTION__;
+ trigger_error($msg, E_USER_ERROR);
+ }
+
+ $duplicate = 256 % $popsize;
+
+ $str = "";
+ for ($i = 0; $i < $length; $i++) {
+ do {
+ $n = ord(Auth_OpenID_CryptUtil::getBytes(1));
+ } while ($n < $duplicate);
+
+ $n %= $popsize;
+ $str .= $population[$n];
+ }
+
+ return $str;
+ }
+
+ static function constEq($s1, $s2)
+ {
+ if (strlen($s1) != strlen($s2)) {
+ return false;
+ }
+
+ $result = true;
+ $length = strlen($s1);
+ for ($i = 0; $i < $length; $i++) {
+ $result &= ($s1[$i] == $s2[$i]);
+ }
+ return $result;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/DatabaseConnection.php
@@ -1,1 +1,131 @@
+<?php
+/**
+ * The Auth_OpenID_DatabaseConnection class, which is used to emulate
+ * a PEAR database connection.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * An empty base class intended to emulate PEAR connection
+ * functionality in applications that supply their own database
+ * abstraction mechanisms. See {@link Auth_OpenID_SQLStore} for more
+ * information. You should subclass this class if you need to create
+ * an SQL store that needs to access its database using an
+ * application's database abstraction layer instead of a PEAR database
+ * connection. Any subclass of Auth_OpenID_DatabaseConnection MUST
+ * adhere to the interface specified here.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_DatabaseConnection {
+ /**
+ * Sets auto-commit mode on this database connection.
+ *
+ * @param bool $mode True if auto-commit is to be used; false if
+ * not.
+ */
+ function autoCommit($mode)
+ {
+ }
+
+ /**
+ * Run an SQL query with the specified parameters, if any.
+ *
+ * @param string $sql An SQL string with placeholders. The
+ * placeholders are assumed to be specific to the database engine
+ * for this connection.
+ *
+ * @param array $params An array of parameters to insert into the
+ * SQL string using this connection's escaping mechanism.
+ *
+ * @return mixed $result The result of calling this connection's
+ * internal query function. The type of result depends on the
+ * underlying database engine. This method is usually used when
+ * the result of a query is not important, like a DDL query.
+ */
+ function query($sql, $params = array())
+ {
+ }
+
+ /**
+ * Starts a transaction on this connection, if supported.
+ */
+ function begin()
+ {
+ }
+
+ /**
+ * Commits a transaction on this connection, if supported.
+ */
+ function commit()
+ {
+ }
+
+ /**
+ * Performs a rollback on this connection, if supported.
+ */
+ function rollback()
+ {
+ }
+
+ /**
+ * Run an SQL query and return the first column of the first row
+ * of the result set, if any.
+ *
+ * @param string $sql An SQL string with placeholders. The
+ * placeholders are assumed to be specific to the database engine
+ * for this connection.
+ *
+ * @param array $params An array of parameters to insert into the
+ * SQL string using this connection's escaping mechanism.
+ *
+ * @return mixed $result The value of the first column of the
+ * first row of the result set. False if no such result was
+ * found.
+ */
+ function getOne($sql, $params = array())
+ {
+ }
+
+ /**
+ * Run an SQL query and return the first row of the result set, if
+ * any.
+ *
+ * @param string $sql An SQL string with placeholders. The
+ * placeholders are assumed to be specific to the database engine
+ * for this connection.
+ *
+ * @param array $params An array of parameters to insert into the
+ * SQL string using this connection's escaping mechanism.
+ *
+ * @return array $result The first row of the result set, if any,
+ * keyed on column name. False if no such result was found.
+ */
+ function getRow($sql, $params = array())
+ {
+ }
+
+ /**
+ * Run an SQL query with the specified parameters, if any.
+ *
+ * @param string $sql An SQL string with placeholders. The
+ * placeholders are assumed to be specific to the database engine
+ * for this connection.
+ *
+ * @param array $params An array of parameters to insert into the
+ * SQL string using this connection's escaping mechanism.
+ *
+ * @return array $result An array of arrays representing the
+ * result of the query; each array is keyed on column name.
+ */
+ function getAll($sql, $params = array())
+ {
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/DiffieHellman.php
@@ -1,1 +1,114 @@
+<?php
+/**
+ * The OpenID library's Diffie-Hellman implementation.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @access private
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+require_once 'Auth/OpenID.php';
+require_once 'Auth/OpenID/BigMath.php';
+
+function Auth_OpenID_getDefaultMod()
+{
+ return '155172898181473697471232257763715539915724801'.
+ '966915404479707795314057629378541917580651227423'.
+ '698188993727816152646631438561595825688188889951'.
+ '272158842675419950341258706556549803580104870537'.
+ '681476726513255747040765857479291291572334510643'.
+ '245094715007229621094194349783925984760375594985'.
+ '848253359305585439638443';
+}
+
+function Auth_OpenID_getDefaultGen()
+{
+ return '2';
+}
+
+/**
+ * The Diffie-Hellman key exchange class. This class relies on
+ * {@link Auth_OpenID_MathLibrary} to perform large number operations.
+ *
+ * @access private
+ * @package OpenID
+ */
+class Auth_OpenID_DiffieHellman {
+
+ var $mod;
+ var $gen;
+ var $private;
+ var $lib = null;
+
+ function Auth_OpenID_DiffieHellman($mod = null, $gen = null,
+ $private = null, $lib = null)
+ {
+ if ($lib === null) {
+ $this->lib = Auth_OpenID_getMathLib();
+ } else {
+ $this->lib = $lib;
+ }
+
+ if ($mod === null) {
+ $this->mod = $this->lib->init(Auth_OpenID_getDefaultMod());
+ } else {
+ $this->mod = $mod;
+ }
+
+ if ($gen === null) {
+ $this->gen = $this->lib->init(Auth_OpenID_getDefaultGen());
+ } else {
+ $this->gen = $gen;
+ }
+
+ if ($private === null) {
+ $r = $this->lib->rand($this->mod);
+ $this->private = $this->lib->add($r, 1);
+ } else {
+ $this->private = $private;
+ }
+
+ $this->public = $this->lib->powmod($this->gen, $this->private,
+ $this->mod);
+ }
+
+ function getSharedSecret($composite)
+ {
+ return $this->lib->powmod($composite, $this->private, $this->mod);
+ }
+
+ function getPublicKey()
+ {
+ return $this->public;
+ }
+
+ function usingDefaultValues()
+ {
+ return ($this->mod == Auth_OpenID_getDefaultMod() &&
+ $this->gen == Auth_OpenID_getDefaultGen());
+ }
+
+ function xorSecret($composite, $secret, $hash_func)
+ {
+ $dh_shared = $this->getSharedSecret($composite);
+ $dh_shared_str = $this->lib->longToBinary($dh_shared);
+ $hash_dh_shared = $hash_func($dh_shared_str);
+
+ $xsecret = "";
+ for ($i = 0; $i < Auth_OpenID::bytes($secret); $i++) {
+ $xsecret .= chr(ord($secret[$i]) ^ ord($hash_dh_shared[$i]));
+ }
+
+ return $xsecret;
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Discover.php
@@ -1,1 +1,607 @@
-
+<?php
+
+/**
+ * The OpenID and Yadis discovery implementation for OpenID 1.2.
+ */
+
+require_once "Auth/OpenID.php";
+require_once "Auth/OpenID/Parse.php";
+require_once "Auth/OpenID/Message.php";
+require_once "Auth/Yadis/XRIRes.php";
+require_once "Auth/Yadis/Yadis.php";
+
+// XML namespace value
+define('Auth_OpenID_XMLNS_1_0', 'http://openid.net/xmlns/1.0');
+
+// Yadis service types
+define('Auth_OpenID_TYPE_1_2', 'http://openid.net/signon/1.2');
+define('Auth_OpenID_TYPE_1_1', 'http://openid.net/signon/1.1');
+define('Auth_OpenID_TYPE_1_0', 'http://openid.net/signon/1.0');
+define('Auth_OpenID_TYPE_2_0_IDP', 'http://specs.openid.net/auth/2.0/server');
+define('Auth_OpenID_TYPE_2_0', 'http://specs.openid.net/auth/2.0/signon');
+define('Auth_OpenID_RP_RETURN_TO_URL_TYPE',
+ 'http://specs.openid.net/auth/2.0/return_to');
+
+function Auth_OpenID_getOpenIDTypeURIs()
+{
+ return array(Auth_OpenID_TYPE_2_0_IDP,
+ Auth_OpenID_TYPE_2_0,
+ Auth_OpenID_TYPE_1_2,
+ Auth_OpenID_TYPE_1_1,
+ Auth_OpenID_TYPE_1_0);
+}
+
+function Auth_OpenID_getOpenIDConsumerTypeURIs()
+{
+ return array(Auth_OpenID_RP_RETURN_TO_URL_TYPE);
+}
+
+
+/*
+ * Provides a user-readable interpretation of a type uri.
+ * Useful for error messages.
+ */
+function Auth_OpenID_getOpenIDTypeName($type_uri) {
+ switch ($type_uri) {
+ case Auth_OpenID_TYPE_2_0_IDP:
+ return 'OpenID 2.0 IDP';
+ case Auth_OpenID_TYPE_2_0:
+ return 'OpenID 2.0';
+ case Auth_OpenID_TYPE_1_2:
+ return 'OpenID 1.2';
+ case Auth_OpenID_TYPE_1_1:
+ return 'OpenID 1.1';
+ case Auth_OpenID_TYPE_1_0:
+ return 'OpenID 1.0';
+ case Auth_OpenID_RP_RETURN_TO_URL_TYPE:
+ return 'OpenID relying party';
+ }
+}
+
+/**
+ * Object representing an OpenID service endpoint.
+ */
+class Auth_OpenID_ServiceEndpoint {
+ function Auth_OpenID_ServiceEndpoint()
+ {
+ $this->claimed_id = null;
+ $this->server_url = null;
+ $this->type_uris = array();
+ $this->local_id = null;
+ $this->canonicalID = null;
+ $this->used_yadis = false; // whether this came from an XRDS
+ $this->display_identifier = null;
+ }
+
+ function getDisplayIdentifier()
+ {
+ if ($this->display_identifier) {
+ return $this->display_identifier;
+ }
+ if (! $this->claimed_id) {
+ return $this->claimed_id;
+ }
+ $parsed = parse_url($this->claimed_id);
+ $scheme = $parsed['scheme'];
+ $host = $parsed['host'];
+ $path = $parsed['path'];
+ if (array_key_exists('query', $parsed)) {
+ $query = $parsed['query'];
+ $no_frag = "$scheme://$host$path?$query";
+ } else {
+ $no_frag = "$scheme://$host$path";
+ }
+ return $no_frag;
+ }
+
+ function usesExtension($extension_uri)
+ {
+ return in_array($extension_uri, $this->type_uris);
+ }
+
+ function preferredNamespace()
+ {
+ if (in_array(Auth_OpenID_TYPE_2_0_IDP, $this->type_uris) ||
+ in_array(Auth_OpenID_TYPE_2_0, $this->type_uris)) {
+ return Auth_OpenID_OPENID2_NS;
+ } else {
+ return Auth_OpenID_OPENID1_NS;
+ }
+ }
+
+ /*
+ * Query this endpoint to see if it has any of the given type
+ * URIs. This is useful for implementing other endpoint classes
+ * that e.g. need to check for the presence of multiple versions
+ * of a single protocol.
+ *
+ * @param $type_uris The URIs that you wish to check
+ *
+ * @return all types that are in both in type_uris and
+ * $this->type_uris
+ */
+ function matchTypes($type_uris)
+ {
+ $result = array();
+ foreach ($type_uris as $test_uri) {
+ if ($this->supportsType($test_uri)) {
+ $result[] = $test_uri;
+ }
+ }
+
+ return $result;
+ }
+
+ function supportsType($type_uri)
+ {
+ // Does this endpoint support this type?
+ return ((in_array($type_uri, $this->type_uris)) ||
+ (($type_uri == Auth_OpenID_TYPE_2_0) &&
+ $this->isOPIdentifier()));
+ }
+
+ function compatibilityMode()
+ {
+ return $this->preferredNamespace() != Auth_OpenID_OPENID2_NS;
+ }
+
+ function isOPIdentifier()
+ {
+ return in_array(Auth_OpenID_TYPE_2_0_IDP, $this->type_uris);
+ }
+
+ static function fromOPEndpointURL($op_endpoint_url)
+ {
+ // Construct an OP-Identifier OpenIDServiceEndpoint object for
+ // a given OP Endpoint URL
+ $obj = new Auth_OpenID_ServiceEndpoint();
+ $obj->server_url = $op_endpoint_url;
+ $obj->type_uris = array(Auth_OpenID_TYPE_2_0_IDP);
+ return $obj;
+ }
+
+ function parseService($yadis_url, $uri, $type_uris, $service_element)
+ {
+ // Set the state of this object based on the contents of the
+ // service element. Return true if successful, false if not
+ // (if findOPLocalIdentifier returns false).
+ $this->type_uris = $type_uris;
+ $this->server_url = $uri;
+ $this->used_yadis = true;
+
+ if (!$this->isOPIdentifier()) {
+ $this->claimed_id = $yadis_url;
+ $this->local_id = Auth_OpenID_findOPLocalIdentifier(
+ $service_element,
+ $this->type_uris);
+ if ($this->local_id === false) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ function getLocalID()
+ {
+ // Return the identifier that should be sent as the
+ // openid.identity_url parameter to the server.
+ if ($this->local_id === null && $this->canonicalID === null) {
+ return $this->claimed_id;
+ } else {
+ if ($this->local_id) {
+ return $this->local_id;
+ } else {
+ return $this->canonicalID;
+ }
+ }
+ }
+
+ /*
+ * Parse the given document as XRDS looking for OpenID consumer services.
+ *
+ * @return array of Auth_OpenID_ServiceEndpoint or null if the
+ * document cannot be parsed.
+ */
+ function consumerFromXRDS($uri, $xrds_text)
+ {
+ $xrds =& Auth_Yadis_XRDS::parseXRDS($xrds_text);
+
+ if ($xrds) {
+ $yadis_services =
+ $xrds->services(array('filter_MatchesAnyOpenIDConsumerType'));
+ return Auth_OpenID_makeOpenIDEndpoints($uri, $yadis_services);
+ }
+
+ return null;
+ }
+
+ /*
+ * Parse the given document as XRDS looking for OpenID services.
+ *
+ * @return array of Auth_OpenID_ServiceEndpoint or null if the
+ * document cannot be parsed.
+ */
+ static function fromXRDS($uri, $xrds_text)
+ {
+ $xrds = Auth_Yadis_XRDS::parseXRDS($xrds_text);
+
+ if ($xrds) {
+ $yadis_services =
+ $xrds->services(array('filter_MatchesAnyOpenIDType'));
+ return Auth_OpenID_makeOpenIDEndpoints($uri, $yadis_services);
+ }
+
+ return null;
+ }
+
+ /*
+ * Create endpoints from a DiscoveryResult.
+ *
+ * @param discoveryResult Auth_Yadis_DiscoveryResult
+ * @return array of Auth_OpenID_ServiceEndpoint or null if
+ * endpoints cannot be created.
+ */
+ static function fromDiscoveryResult($discoveryResult)
+ {
+ if ($discoveryResult->isXRDS()) {
+ return Auth_OpenID_ServiceEndpoint::fromXRDS(
+ $discoveryResult->normalized_uri,
+ $discoveryResult->response_text);
+ } else {
+ return Auth_OpenID_ServiceEndpoint::fromHTML(
+ $discoveryResult->normalized_uri,
+ $discoveryResult->response_text);
+ }
+ }
+
+ static function fromHTML($uri, $html)
+ {
+ $discovery_types = array(
+ array(Auth_OpenID_TYPE_2_0,
+ 'openid2.provider', 'openid2.local_id'),
+ array(Auth_OpenID_TYPE_1_1,
+ 'openid.server', 'openid.delegate')
+ );
+
+ $services = array();
+
+ foreach ($discovery_types as $triple) {
+ list($type_uri, $server_rel, $delegate_rel) = $triple;
+
+ $urls = Auth_OpenID_legacy_discover($html, $server_rel,
+ $delegate_rel);
+
+ if ($urls === false) {
+ continue;
+ }
+
+ list($delegate_url, $server_url) = $urls;
+
+ $service = new Auth_OpenID_ServiceEndpoint();
+ $service->claimed_id = $uri;
+ $service->local_id = $delegate_url;
+ $service->server_url = $server_url;
+ $service->type_uris = array($type_uri);
+
+ $services[] = $service;
+ }
+
+ return $services;
+ }
+
+ function copy()
+ {
+ $x = new Auth_OpenID_ServiceEndpoint();
+
+ $x->claimed_id = $this->claimed_id;
+ $x->server_url = $this->server_url;
+ $x->type_uris = $this->type_uris;
+ $x->local_id = $this->local_id;
+ $x->canonicalID = $this->canonicalID;
+ $x->used_yadis = $this->used_yadis;
+
+ return $x;
+ }
+}
+
+function Auth_OpenID_findOPLocalIdentifier($service, $type_uris)
+{
+ // Extract a openid:Delegate value from a Yadis Service element.
+ // If no delegate is found, returns null. Returns false on
+ // discovery failure (when multiple delegate/localID tags have
+ // different values).
+
+ $service->parser->registerNamespace('openid',
+ Auth_OpenID_XMLNS_1_0);
+
+ $service->parser->registerNamespace('xrd',
+ Auth_Yadis_XMLNS_XRD_2_0);
+
+ $parser = $service->parser;
+
+ $permitted_tags = array();
+
+ if (in_array(Auth_OpenID_TYPE_1_1, $type_uris) ||
+ in_array(Auth_OpenID_TYPE_1_0, $type_uris)) {
+ $permitted_tags[] = 'openid:Delegate';
+ }
+
+ if (in_array(Auth_OpenID_TYPE_2_0, $type_uris)) {
+ $permitted_tags[] = 'xrd:LocalID';
+ }
+
+ $local_id = null;
+
+ foreach ($permitted_tags as $tag_name) {
+ $tags = $service->getElements($tag_name);
+
+ foreach ($tags as $tag) {
+ $content = $parser->content($tag);
+
+ if ($local_id === null) {
+ $local_id = $content;
+ } else if ($local_id != $content) {
+ return false;
+ }
+ }
+ }
+
+ return $local_id;
+}
+
+function filter_MatchesAnyOpenIDType($service)
+{
+ $uris = $service->getTypes();
+
+ foreach ($uris as $uri) {
+ if (in_array($uri, Auth_OpenID_getOpenIDTypeURIs())) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
+function filter_MatchesAnyOpenIDConsumerType(&$service)
+{
+ $uris = $service->getTypes();
+
+ foreach ($uris as $uri) {
+ if (in_array($uri, Auth_OpenID_getOpenIDConsumerTypeURIs())) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
+function Auth_OpenID_bestMatchingService($service, $preferred_types)
+{
+ // Return the index of the first matching type, or something
+ // higher if no type matches.
+ //
+ // This provides an ordering in which service elements that
+ // contain a type that comes earlier in the preferred types list
+ // come before service elements that come later. If a service
+ // element has more than one type, the most preferred one wins.
+
+ foreach ($preferred_types as $index => $typ) {
+ if (in_array($typ, $service->type_uris)) {
+ return $index;
+ }
+ }
+
+ return count($preferred_types);
+}
+
+function Auth_OpenID_arrangeByType($service_list, $preferred_types)
+{
+ // Rearrange service_list in a new list so services are ordered by
+ // types listed in preferred_types. Return the new list.
+
+ // Build a list with the service elements in tuples whose
+ // comparison will prefer the one with the best matching service
+ $prio_services = array();
+ foreach ($service_list as $index => $service) {
+ $prio_services[] = array(Auth_OpenID_bestMatchingService($service,
+ $preferred_types),
+ $index, $service);
+ }
+
+ sort($prio_services);
+
+ // Now that the services are sorted by priority, remove the sort
+ // keys from the list.
+ foreach ($prio_services as $index => $s) {
+ $prio_services[$index] = $prio_services[$index][2];
+ }
+
+ return $prio_services;
+}
+
+// Extract OP Identifier services. If none found, return the rest,
+// sorted with most preferred first according to
+// OpenIDServiceEndpoint.openid_type_uris.
+//
+// openid_services is a list of OpenIDServiceEndpoint objects.
+//
+// Returns a list of OpenIDServiceEndpoint objects."""
+function Auth_OpenID_getOPOrUserServices($openid_services)
+{
+ $op_services = Auth_OpenID_arrangeByType($openid_services,
+ array(Auth_OpenID_TYPE_2_0_IDP));
+
+ $openid_services = Auth_OpenID_arrangeByType($openid_services,
+ Auth_OpenID_getOpenIDTypeURIs());
+
+ if ($op_services) {
+ return $op_services;
+ } else {
+ return $openid_services;
+ }
+}
+
+function Auth_OpenID_makeOpenIDEndpoints($uri, $yadis_services)
+{
+ $s = array();
+
+ if (!$yadis_services) {
+ return $s;
+ }
+
+ foreach ($yadis_services as $service) {
+ $type_uris = $service->getTypes();
+ $uris = $service->getURIs();
+
+ // If any Type URIs match and there is an endpoint URI
+ // specified, then this is an OpenID endpoint
+ if ($type_uris &&
+ $uris) {
+ foreach ($uris as $service_uri) {
+ $openid_endpoint = new Auth_OpenID_ServiceEndpoint();
+ if ($openid_endpoint->parseService($uri,
+ $service_uri,
+ $type_uris,
+ $service)) {
+ $s[] = $openid_endpoint;
+ }
+ }
+ }
+ }
+
+ return $s;
+}
+
+function Auth_OpenID_discoverWithYadis($uri, $fetcher,
+ $endpoint_filter='Auth_OpenID_getOPOrUserServices',
+ $discover_function=null)
+{
+ // Discover OpenID services for a URI. Tries Yadis and falls back
+ // on old-style <link rel='...'> discovery if Yadis fails.
+
+ // Might raise a yadis.discover.DiscoveryFailure if no document
+ // came back for that URI at all. I don't think falling back to
+ // OpenID 1.0 discovery on the same URL will help, so don't bother
+ // to catch it.
+ if ($discover_function === null) {
+ $discover_function = array('Auth_Yadis_Yadis', 'discover');
+ }
+
+ $openid_services = array();
+
+ $response = call_user_func_array($discover_function,
+ array($uri, $fetcher));
+
+ $yadis_url = $response->normalized_uri;
+ $yadis_services = array();
+
+ if ($response->isFailure() && !$response->isXRDS()) {
+ return array($uri, array());
+ }
+
+ $openid_services = Auth_OpenID_ServiceEndpoint::fromXRDS(
+ $yadis_url,
+ $response->response_text);
+
+ if (!$openid_services) {
+ if ($response->isXRDS()) {
+ return Auth_OpenID_discoverWithoutYadis($uri,
+ $fetcher);
+ }
+
+ // Try to parse the response as HTML to get OpenID 1.0/1.1
+ // <link rel="...">
+ $openid_services = Auth_OpenID_ServiceEndpoint::fromHTML(
+ $yadis_url,
+ $response->response_text);
+ }
+
+ $openid_services = call_user_func_array($endpoint_filter,
+ array($openid_services));
+
+ return array($yadis_url, $openid_services);
+}
+
+function Auth_OpenID_discoverURI($uri, $fetcher)
+{
+ $uri = Auth_OpenID::normalizeUrl($uri);
+ return Auth_OpenID_discoverWithYadis($uri, $fetcher);
+}
+
+function Auth_OpenID_discoverWithoutYadis($uri, $fetcher)
+{
+ $http_resp = @$fetcher->get($uri);
+
+ if ($http_resp->status != 200 and $http_resp->status != 206) {
+ return array($uri, array());
+ }
+
+ $identity_url = $http_resp->final_url;
+
+ // Try to parse the response as HTML to get OpenID 1.0/1.1 <link
+ // rel="...">
+ $openid_services = Auth_OpenID_ServiceEndpoint::fromHTML(
+ $identity_url,
+ $http_resp->body);
+
+ return array($identity_url, $openid_services);
+}
+
+function Auth_OpenID_discoverXRI($iname, $fetcher)
+{
+ $resolver = new Auth_Yadis_ProxyResolver($fetcher);
+ list($canonicalID, $yadis_services) =
+ $resolver->query($iname,
+ Auth_OpenID_getOpenIDTypeURIs(),
+ array('filter_MatchesAnyOpenIDType'));
+
+ $openid_services = Auth_OpenID_makeOpenIDEndpoints($iname,
+ $yadis_services);
+
+ $openid_services = Auth_OpenID_getOPOrUserServices($openid_services);
+
+ for ($i = 0; $i < count($openid_services); $i++) {
+ $openid_services[$i]->canonicalID = $canonicalID;
+ $openid_services[$i]->claimed_id = $canonicalID;
+ $openid_services[$i]->display_identifier = $iname;
+ }
+
+ // FIXME: returned xri should probably be in some normal form
+ return array($iname, $openid_services);
+}
+
+function Auth_OpenID_discover($uri, $fetcher)
+{
+ // If the fetcher (i.e., PHP) doesn't support SSL, we can't do
+ // discovery on an HTTPS URL.
+ if ($fetcher->isHTTPS($uri) && !$fetcher->supportsSSL()) {
+ return array($uri, array());
+ }
+
+ if (Auth_Yadis_identifierScheme($uri) == 'XRI') {
+ $result = Auth_OpenID_discoverXRI($uri, $fetcher);
+ } else {
+ $result = Auth_OpenID_discoverURI($uri, $fetcher);
+ }
+
+ // If the fetcher doesn't support SSL, we can't interact with
+ // HTTPS server URLs; remove those endpoints from the list.
+ if (!$fetcher->supportsSSL()) {
+ $http_endpoints = array();
+ list($new_uri, $endpoints) = $result;
+
+ foreach ($endpoints as $e) {
+ if (!$fetcher->isHTTPS($e->server_url)) {
+ $http_endpoints[] = $e;
+ }
+ }
+
+ $result = array($new_uri, $http_endpoints);
+ }
+
+ return $result;
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/DumbStore.php
@@ -1,1 +1,100 @@
+<?php
+/**
+ * This file supplies a dumb store backend for OpenID servers and
+ * consumers.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Import the interface for creating a new store class.
+ */
+require_once 'Auth/OpenID/Interface.php';
+require_once 'Auth/OpenID/HMAC.php';
+
+/**
+ * This is a store for use in the worst case, when you have no way of
+ * saving state on the consumer site. Using this store makes the
+ * consumer vulnerable to replay attacks, as it's unable to use
+ * nonces. Avoid using this store if it is at all possible.
+ *
+ * Most of the methods of this class are implementation details.
+ * Users of this class need to worry only about the constructor.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_DumbStore extends Auth_OpenID_OpenIDStore {
+
+ /**
+ * Creates a new {@link Auth_OpenID_DumbStore} instance. For the security
+ * of the tokens generated by the library, this class attempts to
+ * at least have a secure implementation of getAuthKey.
+ *
+ * When you create an instance of this class, pass in a secret
+ * phrase. The phrase is hashed with sha1 to make it the correct
+ * length and form for an auth key. That allows you to use a long
+ * string as the secret phrase, which means you can make it very
+ * difficult to guess.
+ *
+ * Each {@link Auth_OpenID_DumbStore} instance that is created for use by
+ * your consumer site needs to use the same $secret_phrase.
+ *
+ * @param string secret_phrase The phrase used to create the auth
+ * key returned by getAuthKey
+ */
+ function Auth_OpenID_DumbStore($secret_phrase)
+ {
+ $this->auth_key = Auth_OpenID_SHA1($secret_phrase);
+ }
+
+ /**
+ * This implementation does nothing.
+ */
+ function storeAssociation($server_url, $association)
+ {
+ }
+
+ /**
+ * This implementation always returns null.
+ */
+ function getAssociation($server_url, $handle = null)
+ {
+ return null;
+ }
+
+ /**
+ * This implementation always returns false.
+ */
+ function removeAssociation($server_url, $handle)
+ {
+ return false;
+ }
+
+ /**
+ * In a system truly limited to dumb mode, nonces must all be
+ * accepted. This therefore always returns true, which makes
+ * replay attacks feasible.
+ */
+ function useNonce($server_url, $timestamp, $salt)
+ {
+ return true;
+ }
+
+ /**
+ * This method returns the auth key generated by the constructor.
+ */
+ function getAuthKey()
+ {
+ return $this->auth_key;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Extension.php
@@ -1,1 +1,62 @@
+<?php
+/**
+ * An interface for OpenID extensions.
+ *
+ * @package OpenID
+ */
+
+/**
+ * Require the Message implementation.
+ */
+require_once 'Auth/OpenID/Message.php';
+
+/**
+ * A base class for accessing extension request and response data for
+ * the OpenID 2 protocol.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Extension {
+ /**
+ * ns_uri: The namespace to which to add the arguments for this
+ * extension
+ */
+ var $ns_uri = null;
+ var $ns_alias = null;
+
+ /**
+ * Get the string arguments that should be added to an OpenID
+ * message for this extension.
+ */
+ function getExtensionArgs()
+ {
+ return null;
+ }
+
+ /**
+ * Add the arguments from this extension to the provided message.
+ *
+ * Returns the message with the extension arguments added.
+ */
+ function toMessage($message)
+ {
+ $implicit = $message->isOpenID1();
+ $added = $message->namespaces->addAlias($this->ns_uri,
+ $this->ns_alias,
+ $implicit);
+
+ if ($added === null) {
+ if ($message->namespaces->getAlias($this->ns_uri) !=
+ $this->ns_alias) {
+ return null;
+ }
+ }
+
+ $message->updateArgs($this->ns_uri,
+ $this->getExtensionArgs());
+ return $message;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/FileStore.php
@@ -1,1 +1,619 @@
-
+<?php
+
+/**
+ * This file supplies a Memcached store backend for OpenID servers and
+ * consumers.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Require base class for creating a new interface.
+ */
+require_once 'Auth/OpenID.php';
+require_once 'Auth/OpenID/Interface.php';
+require_once 'Auth/OpenID/HMAC.php';
+require_once 'Auth/OpenID/Nonce.php';
+
+/**
+ * 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.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_FileStore extends Auth_OpenID_OpenIDStore {
+
+ /**
+ * 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
+ * directories in.
+ */
+ function Auth_OpenID_FileStore($directory)
+ {
+ if (!Auth_OpenID::ensureDir($directory)) {
+ trigger_error('Not a directory and failed to create: '
+ . $directory, E_USER_ERROR);
+ }
+ $directory = realpath($directory);
+
+ $this->directory = $directory;
+ $this->active = true;
+
+ $this->nonce_dir = $directory . DIRECTORY_SEPARATOR . 'nonces';
+
+ $this->association_dir = $directory . DIRECTORY_SEPARATOR .
+ 'associations';
+
+ // Temp dir must be on the same filesystem as the assciations
+ // $directory.
+ $this->temp_dir = $directory . DIRECTORY_SEPARATOR . 'temp';
+
+ $this->max_nonce_age = 6 * 60 * 60; // Six hours, in seconds
+
+ if (!$this->_setup()) {
+ trigger_error('Failed to initialize OpenID file store in ' .
+ $directory, E_USER_ERROR);
+ }
+ }
+
+ function destroy()
+ {
+ Auth_OpenID_FileStore::_rmtree($this->directory);
+ $this->active = false;
+ }
+
+ /**
+ * Make sure that the directories in which we store our data
+ * exist.
+ *
+ * @access private
+ */
+ function _setup()
+ {
+ return (Auth_OpenID::ensureDir($this->nonce_dir) &&
+ Auth_OpenID::ensureDir($this->association_dir) &&
+ Auth_OpenID::ensureDir($this->temp_dir));
+ }
+
+ /**
+ * 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)
+ * @access private
+ */
+ function _mktemp()
+ {
+ $name = Auth_OpenID_FileStore::_mkstemp($dir = $this->temp_dir);
+ $file_obj = @fopen($name, 'wb');
+ if ($file_obj !== false) {
+ return array($file_obj, $name);
+ } else {
+ Auth_OpenID_FileStore::_removeIfPresent($name);
+ }
+ }
+
+ function cleanupNonces()
+ {
+ global $Auth_OpenID_SKEW;
+
+ $nonces = Auth_OpenID_FileStore::_listdir($this->nonce_dir);
+ $now = time();
+
+ $removed = 0;
+ // Check all nonces for expiry
+ foreach ($nonces as $nonce_fname) {
+ $base = basename($nonce_fname);
+ $parts = explode('-', $base, 2);
+ $timestamp = $parts[0];
+ $timestamp = intval($timestamp, 16);
+ if (abs($timestamp - $now) > $Auth_OpenID_SKEW) {
+ Auth_OpenID_FileStore::_removeIfPresent($nonce_fname);
+ $removed += 1;
+ }
+ }
+ return $removed;
+ }
+
+ /**
+ * 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
+ */
+ function getAssociationFilename($server_url, $handle)
+ {
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return null;
+ }
+
+ if (strpos($server_url, '://') === false) {
+ trigger_error(sprintf("Bad server URL: %s", $server_url),
+ E_USER_WARNING);
+ return null;
+ }
+
+ list($proto, $rest) = explode('://', $server_url, 2);
+ $parts = explode('/', $rest);
+ $domain = Auth_OpenID_FileStore::_filenameEscape($parts[0]);
+ $url_hash = Auth_OpenID_FileStore::_safe64($server_url);
+ if ($handle) {
+ $handle_hash = Auth_OpenID_FileStore::_safe64($handle);
+ } else {
+ $handle_hash = '';
+ }
+
+ $filename = sprintf('%s-%s-%s-%s', $proto, $domain, $url_hash,
+ $handle_hash);
+
+ return $this->association_dir. DIRECTORY_SEPARATOR . $filename;
+ }
+
+ /**
+ * Store an association in the association directory.
+ */
+ function storeAssociation($server_url, $association)
+ {
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return false;
+ }
+
+ $association_s = $association->serialize();
+ $filename = $this->getAssociationFilename($server_url,
+ $association->handle);
+ list($tmp_file, $tmp) = $this->_mktemp();
+
+ if (!$tmp_file) {
+ trigger_error("_mktemp didn't return a valid file descriptor",
+ E_USER_WARNING);
+ return false;
+ }
+
+ fwrite($tmp_file, $association_s);
+
+ fflush($tmp_file);
+
+ fclose($tmp_file);
+
+ if (@rename($tmp, $filename)) {
+ return true;
+ } else {
+ // In case we are running on Windows, try unlinking the
+ // file in case it exists.
+ @unlink($filename);
+
+ // Now the target should not exist. Try renaming again,
+ // giving up if it fails.
+ if (@rename($tmp, $filename)) {
+ return true;
+ }
+ }
+
+ // If there was an error, don't leave the temporary file
+ // around.
+ Auth_OpenID_FileStore::_removeIfPresent($tmp);
+ return false;
+ }
+
+ /**
+ * Retrieve an association. If no handle is specified, return the
+ * association with the most recent issue time.
+ *
+ * @return mixed $association
+ */
+ function getAssociation($server_url, $handle = null)
+ {
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return null;
+ }
+
+ if ($handle === null) {
+ $handle = '';
+ }
+
+ // The filename with the empty handle is a prefix of all other
+ // associations for the given server URL.
+ $filename = $this->getAssociationFilename($server_url, $handle);
+
+ if ($handle) {
+ return $this->_getAssociation($filename);
+ } else {
+ $association_files =
+ Auth_OpenID_FileStore::_listdir($this->association_dir);
+ $matching_files = array();
+
+ // strip off the path to do the comparison
+ $name = basename($filename);
+ foreach ($association_files as $association_file) {
+ $base = basename($association_file);
+ if (strpos($base, $name) === 0) {
+ $matching_files[] = $association_file;
+ }
+ }
+
+ $matching_associations = array();
+ // read the matching files and sort by time issued
+ foreach ($matching_files as $full_name) {
+ $association = $this->_getAssociation($full_name);
+ if ($association !== null) {
+ $matching_associations[] = array($association->issued,
+ $association);
+ }
+ }
+
+ $issued = array();
+ $assocs = array();
+ foreach ($matching_associations as $key => $assoc) {
+ $issued[$key] = $assoc[0];
+ $assocs[$key] = $assoc[1];
+ }
+
+ array_multisort($issued, SORT_DESC, $assocs, SORT_DESC,
+ $matching_associations);
+
+ // return the most recently issued one.
+ if ($matching_associations) {
+ list($issued, $assoc) = $matching_associations[0];
+ return $assoc;
+ } else {
+ return null;
+ }
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _getAssociation($filename)
+ {
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return null;
+ }
+
+ $assoc_file = @fopen($filename, 'rb');
+
+ if ($assoc_file === false) {
+ return null;
+ }
+
+ $assoc_s = fread($assoc_file, filesize($filename));
+ fclose($assoc_file);
+
+ if (!$assoc_s) {
+ return null;
+ }
+
+ $association =
+ Auth_OpenID_Association::deserialize('Auth_OpenID_Association',
+ $assoc_s);
+
+ if (!$association) {
+ Auth_OpenID_FileStore::_removeIfPresent($filename);
+ return null;
+ }
+
+ if ($association->getExpiresIn() == 0) {
+ Auth_OpenID_FileStore::_removeIfPresent($filename);
+ return null;
+ } else {
+ return $association;
+ }
+ }
+
+ /**
+ * Remove an association if it exists. Do nothing if it does not.
+ *
+ * @return bool $success
+ */
+ function removeAssociation($server_url, $handle)
+ {
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return null;
+ }
+
+ $assoc = $this->getAssociation($server_url, $handle);
+ if ($assoc === null) {
+ return false;
+ } else {
+ $filename = $this->getAssociationFilename($server_url, $handle);
+ return Auth_OpenID_FileStore::_removeIfPresent($filename);
+ }
+ }
+
+ /**
+ * Return whether this nonce is present. As a side effect, mark it
+ * as no longer present.
+ *
+ * @return bool $present
+ */
+ function useNonce($server_url, $timestamp, $salt)
+ {
+ global $Auth_OpenID_SKEW;
+
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return null;
+ }
+
+ if ( abs($timestamp - time()) > $Auth_OpenID_SKEW ) {
+ return false;
+ }
+
+ if ($server_url) {
+ list($proto, $rest) = explode('://', $server_url, 2);
+ } else {
+ $proto = '';
+ $rest = '';
+ }
+
+ $parts = explode('/', $rest, 2);
+ $domain = $this->_filenameEscape($parts[0]);
+ $url_hash = $this->_safe64($server_url);
+ $salt_hash = $this->_safe64($salt);
+
+ $filename = sprintf('%08x-%s-%s-%s-%s', $timestamp, $proto,
+ $domain, $url_hash, $salt_hash);
+ $filename = $this->nonce_dir . DIRECTORY_SEPARATOR . $filename;
+
+ $result = @fopen($filename, 'x');
+
+ if ($result === false) {
+ return false;
+ } else {
+ fclose($result);
+ return true;
+ }
+ }
+
+ /**
+ * Remove expired entries from the database. This is potentially
+ * expensive, so only run when it is acceptable to take time.
+ *
+ * @access private
+ */
+ function _allAssocs()
+ {
+ $all_associations = array();
+
+ $association_filenames =
+ Auth_OpenID_FileStore::_listdir($this->association_dir);
+
+ foreach ($association_filenames as $association_filename) {
+ $association_file = fopen($association_filename, 'rb');
+
+ if ($association_file !== false) {
+ $assoc_s = fread($association_file,
+ filesize($association_filename));
+ fclose($association_file);
+
+ // Remove expired or corrupted associations
+ $association =
+ Auth_OpenID_Association::deserialize(
+ 'Auth_OpenID_Association', $assoc_s);
+
+ if ($association === null) {
+ Auth_OpenID_FileStore::_removeIfPresent(
+ $association_filename);
+ } else {
+ if ($association->getExpiresIn() == 0) {
+ $all_associations[] = array($association_filename,
+ $association);
+ }
+ }
+ }
+ }
+
+ return $all_associations;
+ }
+
+ function clean()
+ {
+ if (!$this->active) {
+ trigger_error("FileStore no longer active", E_USER_ERROR);
+ return null;
+ }
+
+ $nonces = Auth_OpenID_FileStore::_listdir($this->nonce_dir);
+ $now = time();
+
+ // Check all nonces for expiry
+ foreach ($nonces as $nonce) {
+ if (!Auth_OpenID_checkTimestamp($nonce, $now)) {
+ $filename = $this->nonce_dir . DIRECTORY_SEPARATOR . $nonce;
+ Auth_OpenID_FileStore::_removeIfPresent($filename);
+ }
+ }
+
+ foreach ($this->_allAssocs() as $pair) {
+ list($assoc_filename, $assoc) = $pair;
+ if ($assoc->getExpiresIn() == 0) {
+ Auth_OpenID_FileStore::_removeIfPresent($assoc_filename);
+ }
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _rmtree($dir)
+ {
+ if ($dir[strlen($dir) - 1] != DIRECTORY_SEPARATOR) {
+ $dir .= DIRECTORY_SEPARATOR;
+ }
+
+ if ($handle = opendir($dir)) {
+ while ($item = readdir($handle)) {
+ if (!in_array($item, array('.', '..'))) {
+ if (is_dir($dir . $item)) {
+
+ if (!Auth_OpenID_FileStore::_rmtree($dir . $item)) {
+ return false;
+ }
+ } else if (is_file($dir . $item)) {
+ if (!unlink($dir . $item)) {
+ return false;
+ }
+ }
+ }
+ }
+
+ closedir($handle);
+
+ if (!@rmdir($dir)) {
+ return false;
+ }
+
+ return true;
+ } else {
+ // Couldn't open directory.
+ return false;
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _mkstemp($dir)
+ {
+ foreach (range(0, 4) as $i) {
+ $name = tempnam($dir, "php_openid_filestore_");
+
+ if ($name !== false) {
+ return $name;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * @access private
+ */
+ static function _mkdtemp($dir)
+ {
+ foreach (range(0, 4) as $i) {
+ $name = $dir . strval(DIRECTORY_SEPARATOR) . strval(getmypid()) .
+ "-" . strval(rand(1, time()));
+ if (!mkdir($name, 0700)) {
+ return false;
+ } else {
+ return $name;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * @access private
+ */
+ function _listdir($dir)
+ {
+ $handle = opendir($dir);
+ $files = array();
+ while (false !== ($filename = readdir($handle))) {
+ if (!in_array($filename, array('.', '..'))) {
+ $files[] = $dir . DIRECTORY_SEPARATOR . $filename;
+ }
+ }
+ return $files;
+ }
+
+ /**
+ * @access private
+ */
+ function _isFilenameSafe($char)
+ {
+ $_Auth_OpenID_filename_allowed = Auth_OpenID_letters .
+ Auth_OpenID_digits . ".";
+ return (strpos($_Auth_OpenID_filename_allowed, $char) !== false);
+ }
+
+ /**
+ * @access private
+ */
+ function _safe64($str)
+ {
+ $h64 = base64_encode(Auth_OpenID_SHA1($str));
+ $h64 = str_replace('+', '_', $h64);
+ $h64 = str_replace('/', '.', $h64);
+ $h64 = str_replace('=', '', $h64);
+ return $h64;
+ }
+
+ /**
+ * @access private
+ */
+ function _filenameEscape($str)
+ {
+ $filename = "";
+ $b = Auth_OpenID::toBytes($str);
+
+ for ($i = 0; $i < count($b); $i++) {
+ $c = $b[$i];
+ if (Auth_OpenID_FileStore::_isFilenameSafe($c)) {
+ $filename .= $c;
+ } else {
+ $filename .= sprintf("_%02X", ord($c));
+ }
+ }
+ return $filename;
+ }
+
+ /**
+ * Attempt to remove a file, returning whether the file existed at
+ * the time of the call.
+ *
+ * @access private
+ * @return bool $result True if the file was present, false if not.
+ */
+ function _removeIfPresent($filename)
+ {
+ return @unlink($filename);
+ }
+
+ function cleanupAssociations()
+ {
+ $removed = 0;
+ foreach ($this->_allAssocs() as $pair) {
+ list($assoc_filename, $assoc) = $pair;
+ if ($assoc->getExpiresIn() == 0) {
+ $this->_removeIfPresent($assoc_filename);
+ $removed += 1;
+ }
+ }
+ return $removed;
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/HMAC.php
@@ -1,1 +1,106 @@
+<?php
+/**
+ * This is the HMACSHA1 implementation for the OpenID library.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @access private
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+require_once 'Auth/OpenID.php';
+
+/**
+ * SHA1_BLOCKSIZE is this module's SHA1 blocksize used by the fallback
+ * implementation.
+ */
+define('Auth_OpenID_SHA1_BLOCKSIZE', 64);
+
+function Auth_OpenID_SHA1($text)
+{
+ if (function_exists('hash') &&
+ function_exists('hash_algos') &&
+ (in_array('sha1', hash_algos()))) {
+ // PHP 5 case (sometimes): 'hash' available and 'sha1' algo
+ // supported.
+ return hash('sha1', $text, true);
+ } else if (function_exists('sha1')) {
+ // PHP 4 case: 'sha1' available.
+ $hex = sha1($text);
+ $raw = '';
+ for ($i = 0; $i < 40; $i += 2) {
+ $hexcode = substr($hex, $i, 2);
+ $charcode = (int)base_convert($hexcode, 16, 10);
+ $raw .= chr($charcode);
+ }
+ return $raw;
+ } else {
+ // Explode.
+ trigger_error('No SHA1 function found', E_USER_ERROR);
+ }
+}
+
+/**
+ * Compute an HMAC/SHA1 hash.
+ *
+ * @access private
+ * @param string $key The HMAC key
+ * @param string $text The message text to hash
+ * @return string $mac The MAC
+ */
+function Auth_OpenID_HMACSHA1($key, $text)
+{
+ if (Auth_OpenID::bytes($key) > Auth_OpenID_SHA1_BLOCKSIZE) {
+ $key = Auth_OpenID_SHA1($key, true);
+ }
+
+ if (function_exists('hash_hmac') &&
+ function_exists('hash_algos') &&
+ (in_array('sha1', hash_algos()))) {
+ return hash_hmac('sha1', $text, $key, true);
+ }
+ // Home-made solution
+
+ $key = str_pad($key, Auth_OpenID_SHA1_BLOCKSIZE, chr(0x00));
+ $ipad = str_repeat(chr(0x36), Auth_OpenID_SHA1_BLOCKSIZE);
+ $opad = str_repeat(chr(0x5c), Auth_OpenID_SHA1_BLOCKSIZE);
+ $hash1 = Auth_OpenID_SHA1(($key ^ $ipad) . $text, true);
+ $hmac = Auth_OpenID_SHA1(($key ^ $opad) . $hash1, true);
+ return $hmac;
+}
+
+if (function_exists('hash') &&
+ function_exists('hash_algos') &&
+ (in_array('sha256', hash_algos()))) {
+ function Auth_OpenID_SHA256($text)
+ {
+ // PHP 5 case: 'hash' available and 'sha256' algo supported.
+ return hash('sha256', $text, true);
+ }
+ define('Auth_OpenID_SHA256_SUPPORTED', true);
+} else {
+ define('Auth_OpenID_SHA256_SUPPORTED', false);
+}
+
+if (function_exists('hash_hmac') &&
+ function_exists('hash_algos') &&
+ (in_array('sha256', hash_algos()))) {
+
+ function Auth_OpenID_HMACSHA256($key, $text)
+ {
+ // Return raw MAC (not hex string).
+ return hash_hmac('sha256', $text, $key, true);
+ }
+
+ define('Auth_OpenID_HMACSHA256_SUPPORTED', true);
+} else {
+ define('Auth_OpenID_HMACSHA256_SUPPORTED', false);
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Interface.php
@@ -1,1 +1,197 @@
+<?php
+/**
+ * This file specifies the interface for PHP OpenID store implementations.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * This is the interface for the store objects the OpenID library
+ * uses. It is a single class that provides all of the persistence
+ * mechanisms that the OpenID library needs, for both servers and
+ * consumers. If you want to create an SQL-driven store, please see
+ * then {@link Auth_OpenID_SQLStore} class.
+ *
+ * Change: Version 2.0 removed the storeNonce, getAuthKey, and isDumb
+ * methods, and changed the behavior of the useNonce method to support
+ * one-way nonces.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ */
+class Auth_OpenID_OpenIDStore {
+ /**
+ * This method puts an Association object into storage,
+ * retrievable by server URL and handle.
+ *
+ * @param string $server_url The URL of the identity server that
+ * this association is with. Because of the way the server portion
+ * of the library uses this interface, don't assume there are any
+ * limitations on the character set of the input string. In
+ * particular, expect to see unescaped non-url-safe characters in
+ * the server_url field.
+ *
+ * @param Association $association The Association to store.
+ */
+ function storeAssociation($server_url, $association)
+ {
+ trigger_error("Auth_OpenID_OpenIDStore::storeAssociation ".
+ "not implemented", E_USER_ERROR);
+ }
+
+ /*
+ * Remove expired nonces from the store.
+ *
+ * Discards any nonce from storage that is old enough that its
+ * timestamp would not pass useNonce().
+ *
+ * This method is not called in the normal operation of the
+ * library. It provides a way for store admins to keep their
+ * storage from filling up with expired data.
+ *
+ * @return the number of nonces expired
+ */
+ function cleanupNonces()
+ {
+ trigger_error("Auth_OpenID_OpenIDStore::cleanupNonces ".
+ "not implemented", E_USER_ERROR);
+ }
+
+ /*
+ * Remove expired associations from the store.
+ *
+ * This method is not called in the normal operation of the
+ * library. It provides a way for store admins to keep their
+ * storage from filling up with expired data.
+ *
+ * @return the number of associations expired.
+ */
+ function cleanupAssociations()
+ {
+ trigger_error("Auth_OpenID_OpenIDStore::cleanupAssociations ".
+ "not implemented", E_USER_ERROR);
+ }
+
+ /*
+ * Shortcut for cleanupNonces(), cleanupAssociations().
+ *
+ * This method is not called in the normal operation of the
+ * library. It provides a way for store admins to keep their
+ * storage from filling up with expired data.
+ */
+ function cleanup()
+ {
+ return array($this->cleanupNonces(),
+ $this->cleanupAssociations());
+ }
+
+ /**
+ * Report whether this storage supports cleanup
+ */
+ function supportsCleanup()
+ {
+ return true;
+ }
+
+ /**
+ * This method returns an Association object from storage that
+ * matches the server URL and, if specified, handle. It returns
+ * null if no such association is found or if the matching
+ * association is expired.
+ *
+ * If no handle is specified, the store may return any association
+ * which matches the server URL. If multiple associations are
+ * valid, the recommended return value for this method is the one
+ * most recently issued.
+ *
+ * This method is allowed (and encouraged) to garbage collect
+ * expired associations when found. This method must not return
+ * expired associations.
+ *
+ * @param string $server_url The URL of the identity server to get
+ * the association for. Because of the way the server portion of
+ * the library uses this interface, don't assume there are any
+ * limitations on the character set of the input string. In
+ * particular, expect to see unescaped non-url-safe characters in
+ * the server_url field.
+ *
+ * @param mixed $handle This optional parameter is the handle of
+ * the specific association to get. If no specific handle is
+ * provided, any valid association matching the server URL is
+ * returned.
+ *
+ * @return Association The Association for the given identity
+ * server.
+ */
+ function getAssociation($server_url, $handle = null)
+ {
+ trigger_error("Auth_OpenID_OpenIDStore::getAssociation ".
+ "not implemented", E_USER_ERROR);
+ }
+
+ /**
+ * This method removes the matching association if it's found, and
+ * returns whether the association was removed or not.
+ *
+ * @param string $server_url The URL of the identity server the
+ * association to remove belongs to. Because of the way the server
+ * portion of the library uses this interface, don't assume there
+ * are any limitations on the character set of the input
+ * string. In particular, expect to see unescaped non-url-safe
+ * characters in the server_url field.
+ *
+ * @param string $handle This is the handle of the association to
+ * remove. If there isn't an association found that matches both
+ * the given URL and handle, then there was no matching handle
+ * found.
+ *
+ * @return mixed Returns whether or not the given association existed.
+ */
+ function removeAssociation($server_url, $handle)
+ {
+ trigger_error("Auth_OpenID_OpenIDStore::removeAssociation ".
+ "not implemented", E_USER_ERROR);
+ }
+
+ /**
+ * Called when using a nonce.
+ *
+ * This method should return C{True} if the nonce has not been
+ * used before, and store it for a while to make sure nobody
+ * tries to use the same value again. If the nonce has already
+ * been used, return C{False}.
+ *
+ * Change: In earlier versions, round-trip nonces were used and a
+ * nonce was only valid if it had been previously stored with
+ * storeNonce. Version 2.0 uses one-way nonces, requiring a
+ * different implementation here that does not depend on a
+ * storeNonce call. (storeNonce is no longer part of the
+ * interface.
+ *
+ * @param string $nonce The nonce to use.
+ *
+ * @return bool Whether or not the nonce was valid.
+ */
+ function useNonce($server_url, $timestamp, $salt)
+ {
+ trigger_error("Auth_OpenID_OpenIDStore::useNonce ".
+ "not implemented", E_USER_ERROR);
+ }
+
+ /**
+ * Removes all entries from the store; implementation is optional.
+ */
+ function reset()
+ {
+ }
+
+}
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/KVForm.php
@@ -1,1 +1,112 @@
+<?php
+/**
+ * OpenID protocol key-value/comma-newline format parsing and
+ * serialization
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @access private
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Container for key-value/comma-newline OpenID format and parsing
+ */
+class Auth_OpenID_KVForm {
+ /**
+ * Convert an OpenID colon/newline separated string into an
+ * associative array
+ *
+ * @static
+ * @access private
+ */
+ static function toArray($kvs, $strict=false)
+ {
+ $lines = explode("\n", $kvs);
+
+ $last = array_pop($lines);
+ if ($last !== '') {
+ array_push($lines, $last);
+ if ($strict) {
+ return false;
+ }
+ }
+
+ $values = array();
+
+ for ($lineno = 0; $lineno < count($lines); $lineno++) {
+ $line = $lines[$lineno];
+ $kv = explode(':', $line, 2);
+ if (count($kv) != 2) {
+ if ($strict) {
+ return false;
+ }
+ continue;
+ }
+
+ $key = $kv[0];
+ $tkey = trim($key);
+ if ($tkey != $key) {
+ if ($strict) {
+ return false;
+ }
+ }
+
+ $value = $kv[1];
+ $tval = trim($value);
+ if ($tval != $value) {
+ if ($strict) {
+ return false;
+ }
+ }
+
+ $values[$tkey] = $tval;
+ }
+
+ return $values;
+ }
+
+ /**
+ * Convert an array into an OpenID colon/newline separated string
+ *
+ * @static
+ * @access private
+ */
+ static function fromArray($values)
+ {
+ if ($values === null) {
+ return null;
+ }
+
+ ksort($values);
+
+ $serialized = '';
+ foreach ($values as $key => $value) {
+ if (is_array($value)) {
+ list($key, $value) = array($value[0], $value[1]);
+ }
+
+ if (strpos($key, ':') !== false) {
+ return null;
+ }
+
+ if (strpos($key, "\n") !== false) {
+ return null;
+ }
+
+ if (strpos($value, "\n") !== false) {
+ return null;
+ }
+ $serialized .= "$key:$value\n";
+ }
+ return $serialized;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/MDB2Store.php
@@ -1,1 +1,414 @@
-
+<?php
+
+/**
+ * SQL-backed OpenID stores for use with PEAR::MDB2.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005 Janrain, Inc.
+ * @license http://www.gnu.org/copyleft/lesser.html LGPL
+ */
+
+require_once 'MDB2.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/Interface.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/Nonce.php';
+
+/**
+ * This store uses a PEAR::MDB2 connection to store persistence
+ * information.
+ *
+ * The table names used are determined by the class variables
+ * associations_table_name and nonces_table_name. To change the name
+ * of the tables used, pass new table names into the constructor.
+ *
+ * To create the tables with the proper schema, see the createTables
+ * method.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_MDB2Store extends Auth_OpenID_OpenIDStore {
+ /**
+ * This creates a new MDB2Store instance. It requires an
+ * established database connection be given to it, and it allows
+ * overriding the default table names.
+ *
+ * @param connection $connection This must be an established
+ * connection to a database of the correct type for the SQLStore
+ * subclass you're using. This must be a PEAR::MDB2 connection
+ * handle.
+ *
+ * @param associations_table: This is an optional parameter to
+ * specify the name of the table used for storing associations.
+ * The default value is 'oid_associations'.
+ *
+ * @param nonces_table: This is an optional parameter to specify
+ * the name of the table used for storing nonces. The default
+ * value is 'oid_nonces'.
+ */
+ function Auth_OpenID_MDB2Store($connection,
+ $associations_table = null,
+ $nonces_table = null)
+ {
+ $this->associations_table_name = "oid_associations";
+ $this->nonces_table_name = "oid_nonces";
+
+ // Check the connection object type to be sure it's a PEAR
+ // database connection.
+ if (!is_object($connection) ||
+ !is_subclass_of($connection, 'mdb2_driver_common')) {
+ trigger_error("Auth_OpenID_MDB2Store expected PEAR connection " .
+ "object (got ".get_class($connection).")",
+ E_USER_ERROR);
+ return;
+ }
+
+ $this->connection = $connection;
+
+ // Be sure to set the fetch mode so the results are keyed on
+ // column name instead of column index.
+ $this->connection->setFetchMode(MDB2_FETCHMODE_ASSOC);
+
+ if (PEAR::isError($this->connection->loadModule('Extended'))) {
+ trigger_error("Unable to load MDB2_Extended module", E_USER_ERROR);
+ return;
+ }
+
+ if ($associations_table) {
+ $this->associations_table_name = $associations_table;
+ }
+
+ if ($nonces_table) {
+ $this->nonces_table_name = $nonces_table;
+ }
+
+ $this->max_nonce_age = 6 * 60 * 60;
+ }
+
+ function tableExists($table_name)
+ {
+ return !PEAR::isError($this->connection->query(
+ sprintf("SELECT * FROM %s LIMIT 0",
+ $table_name)));
+ }
+
+ function createTables()
+ {
+ $n = $this->create_nonce_table();
+ $a = $this->create_assoc_table();
+
+ if (!$n || !$a) {
+ return false;
+ }
+ return true;
+ }
+
+ function create_nonce_table()
+ {
+ if (!$this->tableExists($this->nonces_table_name)) {
+ switch ($this->connection->phptype) {
+ case "mysql":
+ case "mysqli":
+ // Custom SQL for MySQL to use InnoDB and variable-
+ // length keys
+ $r = $this->connection->exec(
+ sprintf("CREATE TABLE %s (\n".
+ " server_url VARCHAR(2047) NOT NULL DEFAULT '',\n".
+ " timestamp INTEGER NOT NULL,\n".
+ " salt CHAR(40) NOT NULL,\n".
+ " UNIQUE (server_url(255), timestamp, salt)\n".
+ ") TYPE=InnoDB",
+ $this->nonces_table_name));
+ if (PEAR::isError($r)) {
+ return false;
+ }
+ break;
+ default:
+ if (PEAR::isError(
+ $this->connection->loadModule('Manager'))) {
+ return false;
+ }
+ $fields = array(
+ "server_url" => array(
+ "type" => "text",
+ "length" => 2047,
+ "notnull" => true
+ ),
+ "timestamp" => array(
+ "type" => "integer",
+ "notnull" => true
+ ),
+ "salt" => array(
+ "type" => "text",
+ "length" => 40,
+ "fixed" => true,
+ "notnull" => true
+ )
+ );
+ $constraint = array(
+ "unique" => 1,
+ "fields" => array(
+ "server_url" => true,
+ "timestamp" => true,
+ "salt" => true
+ )
+ );
+
+ $r = $this->connection->createTable($this->nonces_table_name,
+ $fields);
+ if (PEAR::isError($r)) {
+ return false;
+ }
+
+ $r = $this->connection->createConstraint(
+ $this->nonces_table_name,
+ $this->nonces_table_name . "_constraint",
+ $constraint);
+ if (PEAR::isError($r)) {
+ return false;
+ }
+ break;
+ }
+ }
+ return true;
+ }
+
+ function create_assoc_table()
+ {
+ if (!$this->tableExists($this->associations_table_name)) {
+ switch ($this->connection->phptype) {
+ case "mysql":
+ case "mysqli":
+ // Custom SQL for MySQL to use InnoDB and variable-
+ // length keys
+ $r = $this->connection->exec(
+ sprintf("CREATE TABLE %s(\n".
+ " server_url VARCHAR(2047) NOT NULL DEFAULT '',\n".
+ " handle VARCHAR(255) NOT NULL,\n".
+ " secret BLOB NOT NULL,\n".
+ " issued INTEGER NOT NULL,\n".
+ " lifetime INTEGER NOT NULL,\n".
+ " assoc_type VARCHAR(64) NOT NULL,\n".
+ " PRIMARY KEY (server_url(255), handle)\n".
+ ") TYPE=InnoDB",
+ $this->associations_table_name));
+ if (PEAR::isError($r)) {
+ return false;
+ }
+ break;
+ default:
+ if (PEAR::isError(
+ $this->connection->loadModule('Manager'))) {
+ return false;
+ }
+ $fields = array(
+ "server_url" => array(
+ "type" => "text",
+ "length" => 2047,
+ "notnull" => true
+ ),
+ "handle" => array(
+ "type" => "text",
+ "length" => 255,
+ "notnull" => true
+ ),
+ "secret" => array(
+ "type" => "blob",
+ "length" => "255",
+ "notnull" => true
+ ),
+ "issued" => array(
+ "type" => "integer",
+ "notnull" => true
+ ),
+ "lifetime" => array(
+ "type" => "integer",
+ "notnull" => true
+ ),
+ "assoc_type" => array(
+ "type" => "text",
+ "length" => 64,
+ "notnull" => true
+ )
+ );
+ $options = array(
+ "primary" => array(
+ "server_url" => true,
+ "handle" => true
+ )
+ );
+
+ $r = $this->connection->createTable(
+ $this->associations_table_name,
+ $fields,
+ $options);
+ if (PEAR::isError($r)) {
+ return false;
+ }
+ break;
+ }
+ }
+ return true;
+ }
+
+ function storeAssociation($server_url, $association)
+ {
+ $fields = array(
+ "server_url" => array(
+ "value" => $server_url,
+ "key" => true
+ ),
+ "handle" => array(
+ "value" => $association->handle,
+ "key" => true
+ ),
+ "secret" => array(
+ "value" => $association->secret,
+ "type" => "blob"
+ ),
+ "issued" => array(
+ "value" => $association->issued
+ ),
+ "lifetime" => array(
+ "value" => $association->lifetime
+ ),
+ "assoc_type" => array(
+ "value" => $association->assoc_type
+ )
+ );
+
+ return !PEAR::isError($this->connection->replace(
+ $this->associations_table_name,
+ $fields));
+ }
+
+ function cleanupNonces()
+ {
+ global $Auth_OpenID_SKEW;
+ $v = time() - $Auth_OpenID_SKEW;
+
+ return $this->connection->exec(
+ sprintf("DELETE FROM %s WHERE timestamp < %d",
+ $this->nonces_table_name, $v));
+ }
+
+ function cleanupAssociations()
+ {
+ return $this->connection->exec(
+ sprintf("DELETE FROM %s WHERE issued + lifetime < %d",
+ $this->associations_table_name, time()));
+ }
+
+ function getAssociation($server_url, $handle = null)
+ {
+ $sql = "";
+ $params = null;
+ $types = array(
+ "text",
+ "blob",
+ "integer",
+ "integer",
+ "text"
+ );
+ if ($handle !== null) {
+ $sql = sprintf("SELECT handle, secret, issued, lifetime, assoc_type " .
+ "FROM %s WHERE server_url = ? AND handle = ?",
+ $this->associations_table_name);
+ $params = array($server_url, $handle);
+ } else {
+ $sql = sprintf("SELECT handle, secret, issued, lifetime, assoc_type " .
+ "FROM %s WHERE server_url = ? ORDER BY issued DESC",
+ $this->associations_table_name);
+ $params = array($server_url);
+ }
+
+ $assoc = $this->connection->getRow($sql, $types, $params);
+
+ if (!$assoc || PEAR::isError($assoc)) {
+ return null;
+ } else {
+ $association = new Auth_OpenID_Association($assoc['handle'],
+ stream_get_contents(
+ $assoc['secret']),
+ $assoc['issued'],
+ $assoc['lifetime'],
+ $assoc['assoc_type']);
+ fclose($assoc['secret']);
+ return $association;
+ }
+ }
+
+ function removeAssociation($server_url, $handle)
+ {
+ $r = $this->connection->execParam(
+ sprintf("DELETE FROM %s WHERE server_url = ? AND handle = ?",
+ $this->associations_table_name),
+ array($server_url, $handle));
+
+ if (PEAR::isError($r) || $r == 0) {
+ return false;
+ }
+ return true;
+ }
+
+ function useNonce($server_url, $timestamp, $salt)
+ {
+ global $Auth_OpenID_SKEW;
+
+ if (abs($timestamp - time()) > $Auth_OpenID_SKEW ) {
+ return false;
+ }
+
+ $fields = array(
+ "timestamp" => $timestamp,
+ "salt" => $salt
+ );
+
+ if (!empty($server_url)) {
+ $fields["server_url"] = $server_url;
+ }
+
+ $r = $this->connection->autoExecute(
+ $this->nonces_table_name,
+ $fields,
+ MDB2_AUTOQUERY_INSERT);
+
+ if (PEAR::isError($r)) {
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Resets the store by removing all records from the store's
+ * tables.
+ */
+ function reset()
+ {
+ $this->connection->query(sprintf("DELETE FROM %s",
+ $this->associations_table_name));
+
+ $this->connection->query(sprintf("DELETE FROM %s",
+ $this->nonces_table_name));
+ }
+
+}
+
+?>
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/MemcachedStore.php
@@ -1,1 +1,208 @@
-
+<?php
+
+/**
+ * This file supplies a memcached store backend for OpenID servers and
+ * consumers.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author Artemy Tregubenko <me@arty.name>
+ * @copyright 2008 JanRain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ * Contributed by Open Web Technologies <http://openwebtech.ru/>
+ */
+
+/**
+ * Import the interface for creating a new store class.
+ */
+require_once 'Auth/OpenID/Interface.php';
+
+/**
+ * This is a memcached-based store for OpenID associations and
+ * nonces.
+ *
+ * As memcache has limit of 250 chars for key length,
+ * server_url, handle and salt are hashed with sha1().
+ *
+ * Most of the methods of this class are implementation details.
+ * People wishing to just use this store need only pay attention to
+ * the constructor.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_MemcachedStore extends Auth_OpenID_OpenIDStore {
+
+ /**
+ * Initializes a new {@link Auth_OpenID_MemcachedStore} instance.
+ * Just saves memcached object as property.
+ *
+ * @param resource connection Memcache connection resourse
+ */
+ function Auth_OpenID_MemcachedStore($connection, $compress = false)
+ {
+ $this->connection = $connection;
+ $this->compress = $compress ? MEMCACHE_COMPRESSED : 0;
+ }
+
+ /**
+ * Store association until its expiration time in memcached.
+ * Overwrites any existing association with same server_url and
+ * handle. Handles list of associations for every server.
+ */
+ function storeAssociation($server_url, $association)
+ {
+ // create memcached keys for association itself
+ // and list of associations for this server
+ $associationKey = $this->associationKey($server_url,
+ $association->handle);
+ $serverKey = $this->associationServerKey($server_url);
+
+ // get list of associations
+ $serverAssociations = $this->connection->get($serverKey);
+
+ // if no such list, initialize it with empty array
+ if (!$serverAssociations) {
+ $serverAssociations = array();
+ }
+ // and store given association key in it
+ $serverAssociations[$association->issued] = $associationKey;
+
+ // save associations' keys list
+ $this->connection->set(
+ $serverKey,
+ $serverAssociations,
+ $this->compress
+ );
+ // save association itself
+ $this->connection->set(
+ $associationKey,
+ $association,
+ $this->compress,
+ $association->issued + $association->lifetime);
+ }
+
+ /**
+ * Read association from memcached. If no handle given
+ * and multiple associations found, returns latest issued
+ */
+ function getAssociation($server_url, $handle = null)
+ {
+ // simple case: handle given
+ if ($handle !== null) {
+ // get association, return null if failed
+ $association = $this->connection->get(
+ $this->associationKey($server_url, $handle));
+ return $association ? $association : null;
+ }
+
+ // no handle given, working with list
+ // create key for list of associations
+ $serverKey = $this->associationServerKey($server_url);
+
+ // get list of associations
+ $serverAssociations = $this->connection->get($serverKey);
+ // return null if failed or got empty list
+ if (!$serverAssociations) {
+ return null;
+ }
+
+ // get key of most recently issued association
+ $keys = array_keys($serverAssociations);
+ sort($keys);
+ $lastKey = $serverAssociations[array_pop($keys)];
+
+ // get association, return null if failed
+ $association = $this->connection->get($lastKey);
+ return $association ? $association : null;
+ }
+
+ /**
+ * Immediately delete association from memcache.
+ */
+ function removeAssociation($server_url, $handle)
+ {
+ // create memcached keys for association itself
+ // and list of associations for this server
+ $serverKey = $this->associationServerKey($server_url);
+ $associationKey = $this->associationKey($server_url,
+ $handle);
+
+ // get list of associations
+ $serverAssociations = $this->connection->get($serverKey);
+ // return null if failed or got empty list
+ if (!$serverAssociations) {
+ return false;
+ }
+
+ // ensure that given association key exists in list
+ $serverAssociations = array_flip($serverAssociations);
+ if (!array_key_exists($associationKey, $serverAssociations)) {
+ return false;
+ }
+
+ // remove given association key from list
+ unset($serverAssociations[$associationKey]);
+ $serverAssociations = array_flip($serverAssociations);
+
+ // save updated list
+ $this->connection->set(
+ $serverKey,
+ $serverAssociations,
+ $this->compress
+ );
+
+ // delete association
+ return $this->connection->delete($associationKey);
+ }
+
+ /**
+ * Create nonce for server and salt, expiring after
+ * $Auth_OpenID_SKEW seconds.
+ */
+ function useNonce($server_url, $timestamp, $salt)
+ {
+ global $Auth_OpenID_SKEW;
+
+ // save one request to memcache when nonce obviously expired
+ if (abs($timestamp - time()) > $Auth_OpenID_SKEW) {
+ return false;
+ }
+
+ // returns false when nonce already exists
+ // otherwise adds nonce
+ return $this->connection->add(
+ 'openid_nonce_' . sha1($server_url) . '_' . sha1($salt),
+ 1, // any value here
+ $this->compress,
+ $Auth_OpenID_SKEW);
+ }
+
+ /**
+ * Memcache key is prefixed with 'openid_association_' string.
+ */
+ function associationKey($server_url, $handle = null)
+ {
+ return 'openid_association_' . sha1($server_url) . '_' . sha1($handle);
+ }
+
+ /**
+ * Memcache key is prefixed with 'openid_association_' string.
+ */
+ function associationServerKey($server_url)
+ {
+ return 'openid_association_server_' . sha1($server_url);
+ }
+
+ /**
+ * Report that this storage doesn't support cleanup
+ */
+ function supportsCleanup()
+ {
+ return false;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Message.php
@@ -1,1 +1,921 @@
-
+<?php
+
+/**
+ * Extension argument processing code
+ *
+ * @package OpenID
+ */
+
+/**
+ * Import tools needed to deal with messages.
+ */
+require_once 'Auth/OpenID.php';
+require_once 'Auth/OpenID/KVForm.php';
+require_once 'Auth/Yadis/XML.php';
+require_once 'Auth/OpenID/Consumer.php'; // For Auth_OpenID_FailureResponse
+
+// This doesn't REALLY belong here, but where is better?
+define('Auth_OpenID_IDENTIFIER_SELECT',
+ "http://specs.openid.net/auth/2.0/identifier_select");
+
+// URI for Simple Registration extension, the only commonly deployed
+// OpenID 1.x extension, and so a special case
+define('Auth_OpenID_SREG_URI', 'http://openid.net/sreg/1.0');
+
+// The OpenID 1.X namespace URI
+define('Auth_OpenID_OPENID1_NS', 'http://openid.net/signon/1.0');
+define('Auth_OpenID_THE_OTHER_OPENID1_NS', 'http://openid.net/signon/1.1');
+
+function Auth_OpenID_isOpenID1($ns)
+{
+ return ($ns == Auth_OpenID_THE_OTHER_OPENID1_NS) ||
+ ($ns == Auth_OpenID_OPENID1_NS);
+}
+
+// The OpenID 2.0 namespace URI
+define('Auth_OpenID_OPENID2_NS', 'http://specs.openid.net/auth/2.0');
+
+// The namespace consisting of pairs with keys that are prefixed with
+// "openid." but not in another namespace.
+define('Auth_OpenID_NULL_NAMESPACE', 'Null namespace');
+
+// The null namespace, when it is an allowed OpenID namespace
+define('Auth_OpenID_OPENID_NS', 'OpenID namespace');
+
+// The top-level namespace, excluding all pairs with keys that start
+// with "openid."
+define('Auth_OpenID_BARE_NS', 'Bare namespace');
+
+// Sentinel for Message implementation to indicate that getArg should
+// return null instead of returning a default.
+define('Auth_OpenID_NO_DEFAULT', 'NO DEFAULT ALLOWED');
+
+// Limit, in bytes, of identity provider and return_to URLs, including
+// response payload. See OpenID 1.1 specification, Appendix D.
+define('Auth_OpenID_OPENID1_URL_LIMIT', 2047);
+
+// All OpenID protocol fields. Used to check namespace aliases.
+global $Auth_OpenID_OPENID_PROTOCOL_FIELDS;
+$Auth_OpenID_OPENID_PROTOCOL_FIELDS = array(
+ 'ns', 'mode', 'error', 'return_to', 'contact', 'reference',
+ 'signed', 'assoc_type', 'session_type', 'dh_modulus', 'dh_gen',
+ 'dh_consumer_public', 'claimed_id', 'identity', 'realm',
+ 'invalidate_handle', 'op_endpoint', 'response_nonce', 'sig',
+ 'assoc_handle', 'trust_root', 'openid');
+
+// Global namespace / alias registration map. See
+// Auth_OpenID_registerNamespaceAlias.
+global $Auth_OpenID_registered_aliases;
+$Auth_OpenID_registered_aliases = array();
+
+/**
+ * Registers a (namespace URI, alias) mapping in a global namespace
+ * alias map. Raises NamespaceAliasRegistrationError if either the
+ * namespace URI or alias has already been registered with a different
+ * value. This function is required if you want to use a namespace
+ * with an OpenID 1 message.
+ */
+function Auth_OpenID_registerNamespaceAlias($namespace_uri, $alias)
+{
+ global $Auth_OpenID_registered_aliases;
+
+ if (Auth_OpenID::arrayGet($Auth_OpenID_registered_aliases,
+ $alias) == $namespace_uri) {
+ return true;
+ }
+
+ if (in_array($namespace_uri,
+ array_values($Auth_OpenID_registered_aliases))) {
+ return false;
+ }
+
+ if (in_array($alias, array_keys($Auth_OpenID_registered_aliases))) {
+ return false;
+ }
+
+ $Auth_OpenID_registered_aliases[$alias] = $namespace_uri;
+ return true;
+}
+
+/**
+ * Removes a (namespace_uri, alias) registration from the global
+ * namespace alias map. Returns true if the removal succeeded; false
+ * if not (if the mapping did not exist).
+ */
+function Auth_OpenID_removeNamespaceAlias($namespace_uri, $alias)
+{
+ global $Auth_OpenID_registered_aliases;
+
+ if (Auth_OpenID::arrayGet($Auth_OpenID_registered_aliases,
+ $alias) === $namespace_uri) {
+ unset($Auth_OpenID_registered_aliases[$alias]);
+ return true;
+ }
+
+ return false;
+}
+
+/**
+ * An Auth_OpenID_Mapping maintains a mapping from arbitrary keys to
+ * arbitrary values. (This is unlike an ordinary PHP array, whose
+ * keys may be only simple scalars.)
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Mapping {
+ /**
+ * Initialize a mapping. If $classic_array is specified, its keys
+ * and values are used to populate the mapping.
+ */
+ function Auth_OpenID_Mapping($classic_array = null)
+ {
+ $this->keys = array();
+ $this->values = array();
+
+ if (is_array($classic_array)) {
+ foreach ($classic_array as $key => $value) {
+ $this->set($key, $value);
+ }
+ }
+ }
+
+ /**
+ * Returns true if $thing is an Auth_OpenID_Mapping object; false
+ * if not.
+ */
+ static function isA($thing)
+ {
+ return (is_object($thing) &&
+ strtolower(get_class($thing)) == 'auth_openid_mapping');
+ }
+
+ /**
+ * Returns an array of the keys in the mapping.
+ */
+ function keys()
+ {
+ return $this->keys;
+ }
+
+ /**
+ * Returns an array of values in the mapping.
+ */
+ function values()
+ {
+ return $this->values;
+ }
+
+ /**
+ * Returns an array of (key, value) pairs in the mapping.
+ */
+ function items()
+ {
+ $temp = array();
+
+ for ($i = 0; $i < count($this->keys); $i++) {
+ $temp[] = array($this->keys[$i],
+ $this->values[$i]);
+ }
+ return $temp;
+ }
+
+ /**
+ * Returns the "length" of the mapping, or the number of keys.
+ */
+ function len()
+ {
+ return count($this->keys);
+ }
+
+ /**
+ * Sets a key-value pair in the mapping. If the key already
+ * exists, its value is replaced with the new value.
+ */
+ function set($key, $value)
+ {
+ $index = array_search($key, $this->keys);
+
+ if ($index !== false) {
+ $this->values[$index] = $value;
+ } else {
+ $this->keys[] = $key;
+ $this->values[] = $value;
+ }
+ }
+
+ /**
+ * Gets a specified value from the mapping, associated with the
+ * specified key. If the key does not exist in the mapping,
+ * $default is returned instead.
+ */
+ function get($key, $default = null)
+ {
+ $index = array_search($key, $this->keys);
+
+ if ($index !== false) {
+ return $this->values[$index];
+ } else {
+ return $default;
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _reflow()
+ {
+ // PHP is broken yet again. Sort the arrays to remove the
+ // hole in the numeric indexes that make up the array.
+ $old_keys = $this->keys;
+ $old_values = $this->values;
+
+ $this->keys = array();
+ $this->values = array();
+
+ foreach ($old_keys as $k) {
+ $this->keys[] = $k;
+ }
+
+ foreach ($old_values as $v) {
+ $this->values[] = $v;
+ }
+ }
+
+ /**
+ * Deletes a key-value pair from the mapping with the specified
+ * key.
+ */
+ function del($key)
+ {
+ $index = array_search($key, $this->keys);
+
+ if ($index !== false) {
+ unset($this->keys[$index]);
+ unset($this->values[$index]);
+ $this->_reflow();
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Returns true if the specified value has a key in the mapping;
+ * false if not.
+ */
+ function contains($value)
+ {
+ return (array_search($value, $this->keys) !== false);
+ }
+}
+
+/**
+ * Maintains a bijective map between namespace uris and aliases.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_NamespaceMap {
+ function Auth_OpenID_NamespaceMap()
+ {
+ $this->alias_to_namespace = new Auth_OpenID_Mapping();
+ $this->namespace_to_alias = new Auth_OpenID_Mapping();
+ $this->implicit_namespaces = array();
+ }
+
+ function getAlias($namespace_uri)
+ {
+ return $this->namespace_to_alias->get($namespace_uri);
+ }
+
+ function getNamespaceURI($alias)
+ {
+ return $this->alias_to_namespace->get($alias);
+ }
+
+ function iterNamespaceURIs()
+ {
+ // Return an iterator over the namespace URIs
+ return $this->namespace_to_alias->keys();
+ }
+
+ function iterAliases()
+ {
+ // Return an iterator over the aliases"""
+ return $this->alias_to_namespace->keys();
+ }
+
+ function iteritems()
+ {
+ return $this->namespace_to_alias->items();
+ }
+
+ function isImplicit($namespace_uri)
+ {
+ return in_array($namespace_uri, $this->implicit_namespaces);
+ }
+
+ function addAlias($namespace_uri, $desired_alias, $implicit=false)
+ {
+ // Add an alias from this namespace URI to the desired alias
+ global $Auth_OpenID_OPENID_PROTOCOL_FIELDS;
+
+ // Check that desired_alias is not an openid protocol field as
+ // per the spec.
+ if (in_array($desired_alias, $Auth_OpenID_OPENID_PROTOCOL_FIELDS)) {
+ Auth_OpenID::log("\"%s\" is not an allowed namespace alias",
+ $desired_alias);
+ return null;
+ }
+
+ // Check that desired_alias does not contain a period as per
+ // the spec.
+ if (strpos($desired_alias, '.') !== false) {
+ Auth_OpenID::log('"%s" must not contain a dot', $desired_alias);
+ return null;
+ }
+
+ // Check that there is not a namespace already defined for the
+ // desired alias
+ $current_namespace_uri =
+ $this->alias_to_namespace->get($desired_alias);
+
+ if (($current_namespace_uri !== null) &&
+ ($current_namespace_uri != $namespace_uri)) {
+ Auth_OpenID::log('Cannot map "%s" because previous mapping exists',
+ $namespace_uri);
+ return null;
+ }
+
+ // Check that there is not already a (different) alias for
+ // this namespace URI
+ $alias = $this->namespace_to_alias->get($namespace_uri);
+
+ if (($alias !== null) && ($alias != $desired_alias)) {
+ Auth_OpenID::log('Cannot map %s to alias %s. ' .
+ 'It is already mapped to alias %s',
+ $namespace_uri, $desired_alias, $alias);
+ return null;
+ }
+
+ assert((Auth_OpenID_NULL_NAMESPACE === $desired_alias) ||
+ is_string($desired_alias));
+
+ $this->alias_to_namespace->set($desired_alias, $namespace_uri);
+ $this->namespace_to_alias->set($namespace_uri, $desired_alias);
+ if ($implicit) {
+ array_push($this->implicit_namespaces, $namespace_uri);
+ }
+
+ return $desired_alias;
+ }
+
+ function add($namespace_uri)
+ {
+ // Add this namespace URI to the mapping, without caring what
+ // alias it ends up with
+
+ // See if this namespace is already mapped to an alias
+ $alias = $this->namespace_to_alias->get($namespace_uri);
+
+ if ($alias !== null) {
+ return $alias;
+ }
+
+ // Fall back to generating a numerical alias
+ $i = 0;
+ while (1) {
+ $alias = 'ext' . strval($i);
+ if ($this->addAlias($namespace_uri, $alias) === null) {
+ $i += 1;
+ } else {
+ return $alias;
+ }
+ }
+
+ // Should NEVER be reached!
+ return null;
+ }
+
+ function contains($namespace_uri)
+ {
+ return $this->isDefined($namespace_uri);
+ }
+
+ function isDefined($namespace_uri)
+ {
+ return $this->namespace_to_alias->contains($namespace_uri);
+ }
+}
+
+/**
+ * In the implementation of this object, null represents the global
+ * namespace as well as a namespace with no key.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Message {
+
+ function Auth_OpenID_Message($openid_namespace = null)
+ {
+ // Create an empty Message
+ $this->allowed_openid_namespaces = array(
+ Auth_OpenID_OPENID1_NS,
+ Auth_OpenID_THE_OTHER_OPENID1_NS,
+ Auth_OpenID_OPENID2_NS);
+
+ $this->args = new Auth_OpenID_Mapping();
+ $this->namespaces = new Auth_OpenID_NamespaceMap();
+ if ($openid_namespace === null) {
+ $this->_openid_ns_uri = null;
+ } else {
+ $implicit = Auth_OpenID_isOpenID1($openid_namespace);
+ $this->setOpenIDNamespace($openid_namespace, $implicit);
+ }
+ }
+
+ function isOpenID1()
+ {
+ return Auth_OpenID_isOpenID1($this->getOpenIDNamespace());
+ }
+
+ function isOpenID2()
+ {
+ return $this->getOpenIDNamespace() == Auth_OpenID_OPENID2_NS;
+ }
+
+ static function fromPostArgs($args)
+ {
+ // Construct a Message containing a set of POST arguments
+ $obj = new Auth_OpenID_Message();
+
+ // Partition into "openid." args and bare args
+ $openid_args = array();
+ foreach ($args as $key => $value) {
+
+ if (is_array($value)) {
+ return null;
+ }
+
+ $parts = explode('.', $key, 2);
+
+ if (count($parts) == 2) {
+ list($prefix, $rest) = $parts;
+ } else {
+ $prefix = null;
+ }
+
+ if ($prefix != 'openid') {
+ $obj->args->set(array(Auth_OpenID_BARE_NS, $key), $value);
+ } else {
+ $openid_args[$rest] = $value;
+ }
+ }
+
+ if ($obj->_fromOpenIDArgs($openid_args)) {
+ return $obj;
+ } else {
+ return null;
+ }
+ }
+
+ static function fromOpenIDArgs($openid_args)
+ {
+ // Takes an array.
+
+ // Construct a Message from a parsed KVForm message
+ $obj = new Auth_OpenID_Message();
+ if ($obj->_fromOpenIDArgs($openid_args)) {
+ return $obj;
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _fromOpenIDArgs($openid_args)
+ {
+ global $Auth_OpenID_registered_aliases;
+
+ // Takes an Auth_OpenID_Mapping instance OR an array.
+
+ if (!Auth_OpenID_Mapping::isA($openid_args)) {
+ $openid_args = new Auth_OpenID_Mapping($openid_args);
+ }
+
+ $ns_args = array();
+
+ // Resolve namespaces
+ foreach ($openid_args->items() as $pair) {
+ list($rest, $value) = $pair;
+
+ $parts = explode('.', $rest, 2);
+
+ if (count($parts) == 2) {
+ list($ns_alias, $ns_key) = $parts;
+ } else {
+ $ns_alias = Auth_OpenID_NULL_NAMESPACE;
+ $ns_key = $rest;
+ }
+
+ if ($ns_alias == 'ns') {
+ if ($this->namespaces->addAlias($value, $ns_key) === null) {
+ return false;
+ }
+ } else if (($ns_alias == Auth_OpenID_NULL_NAMESPACE) &&
+ ($ns_key == 'ns')) {
+ // null namespace
+ if ($this->setOpenIDNamespace($value, false) === false) {
+ return false;
+ }
+ } else {
+ $ns_args[] = array($ns_alias, $ns_key, $value);
+ }
+ }
+
+ if (!$this->getOpenIDNamespace()) {
+ if ($this->setOpenIDNamespace(Auth_OpenID_OPENID1_NS, true) ===
+ false) {
+ return false;
+ }
+ }
+
+ // Actually put the pairs into the appropriate namespaces
+ foreach ($ns_args as $triple) {
+ list($ns_alias, $ns_key, $value) = $triple;
+ $ns_uri = $this->namespaces->getNamespaceURI($ns_alias);
+ if ($ns_uri === null) {
+ $ns_uri = $this->_getDefaultNamespace($ns_alias);
+ if ($ns_uri === null) {
+
+ $ns_uri = Auth_OpenID_OPENID_NS;
+ $ns_key = sprintf('%s.%s', $ns_alias, $ns_key);
+ } else {
+ $this->namespaces->addAlias($ns_uri, $ns_alias, true);
+ }
+ }
+
+ $this->setArg($ns_uri, $ns_key, $value);
+ }
+
+ return true;
+ }
+
+ function _getDefaultNamespace($mystery_alias)
+ {
+ global $Auth_OpenID_registered_aliases;
+ if ($this->isOpenID1()) {
+ return @$Auth_OpenID_registered_aliases[$mystery_alias];
+ }
+ return null;
+ }
+
+ function setOpenIDNamespace($openid_ns_uri, $implicit)
+ {
+ if (!in_array($openid_ns_uri, $this->allowed_openid_namespaces)) {
+ Auth_OpenID::log('Invalid null namespace: "%s"', $openid_ns_uri);
+ return false;
+ }
+
+ $succeeded = $this->namespaces->addAlias($openid_ns_uri,
+ Auth_OpenID_NULL_NAMESPACE,
+ $implicit);
+ if ($succeeded === false) {
+ return false;
+ }
+
+ $this->_openid_ns_uri = $openid_ns_uri;
+
+ return true;
+ }
+
+ function getOpenIDNamespace()
+ {
+ return $this->_openid_ns_uri;
+ }
+
+ static function fromKVForm($kvform_string)
+ {
+ // Create a Message from a KVForm string
+ return Auth_OpenID_Message::fromOpenIDArgs(
+ Auth_OpenID_KVForm::toArray($kvform_string));
+ }
+
+ function copy()
+ {
+ return $this;
+ }
+
+ function toPostArgs()
+ {
+ // Return all arguments with openid. in front of namespaced
+ // arguments.
+
+ $args = array();
+
+ // Add namespace definitions to the output
+ foreach ($this->namespaces->iteritems() as $pair) {
+ list($ns_uri, $alias) = $pair;
+ if ($this->namespaces->isImplicit($ns_uri)) {
+ continue;
+ }
+ if ($alias == Auth_OpenID_NULL_NAMESPACE) {
+ $ns_key = 'openid.ns';
+ } else {
+ $ns_key = 'openid.ns.' . $alias;
+ }
+ $args[$ns_key] = $ns_uri;
+ }
+
+ foreach ($this->args->items() as $pair) {
+ list($ns_parts, $value) = $pair;
+ list($ns_uri, $ns_key) = $ns_parts;
+ $key = $this->getKey($ns_uri, $ns_key);
+ $args[$key] = $value;
+ }
+
+ return $args;
+ }
+
+ function toArgs()
+ {
+ // Return all namespaced arguments, failing if any
+ // non-namespaced arguments exist.
+ $post_args = $this->toPostArgs();
+ $kvargs = array();
+ foreach ($post_args as $k => $v) {
+ if (strpos($k, 'openid.') !== 0) {
+ // raise ValueError(
+ // 'This message can only be encoded as a POST, because it '
+ // 'contains arguments that are not prefixed with "openid."')
+ return null;
+ } else {
+ $kvargs[substr($k, 7)] = $v;
+ }
+ }
+
+ return $kvargs;
+ }
+
+ function toFormMarkup($action_url, $form_tag_attrs = null,
+ $submit_text = "Continue")
+ {
+ $form = "<form accept-charset=\"UTF-8\" ".
+ "enctype=\"application/x-www-form-urlencoded\"";
+
+ if (!$form_tag_attrs) {
+ $form_tag_attrs = array();
+ }
+
+ $form_tag_attrs['action'] = $action_url;
+ $form_tag_attrs['method'] = 'post';
+
+ unset($form_tag_attrs['enctype']);
+ unset($form_tag_attrs['accept-charset']);
+
+ if ($form_tag_attrs) {
+ foreach ($form_tag_attrs as $name => $attr) {
+ $form .= sprintf(" %s=\"%s\"", $name, $attr);
+ }
+ }
+
+ $form .= ">\n";
+
+ foreach ($this->toPostArgs() as $name => $value) {
+ $form .= sprintf(
+ "<input type=\"hidden\" name=\"%s\" value=\"%s\" />\n",
+ $name, urldecode($value));
+ }
+
+ $form .= sprintf("<input type=\"submit\" value=\"%s\" />\n",
+ $submit_text);
+
+ $form .= "</form>\n";
+
+ return $form;
+ }
+
+ function toURL($base_url)
+ {
+ // Generate a GET URL with the parameters in this message
+ // attached as query parameters.
+ return Auth_OpenID::appendArgs($base_url, $this->toPostArgs());
+ }
+
+ function toKVForm()
+ {
+ // Generate a KVForm string that contains the parameters in
+ // this message. This will fail if the message contains
+ // arguments outside of the 'openid.' prefix.
+ return Auth_OpenID_KVForm::fromArray($this->toArgs());
+ }
+
+ function toURLEncoded()
+ {
+ // Generate an x-www-urlencoded string
+ $args = array();
+
+ foreach ($this->toPostArgs() as $k => $v) {
+ $args[] = array($k, $v);
+ }
+
+ sort($args);
+ return Auth_OpenID::httpBuildQuery($args);
+ }
+
+ /**
+ * @access private
+ */
+ function _fixNS($namespace)
+ {
+ // Convert an input value into the internally used values of
+ // this object
+
+ if ($namespace == Auth_OpenID_OPENID_NS) {
+ if ($this->_openid_ns_uri === null) {
+ return new Auth_OpenID_FailureResponse(null,
+ 'OpenID namespace not set');
+ } else {
+ $namespace = $this->_openid_ns_uri;
+ }
+ }
+
+ if (($namespace != Auth_OpenID_BARE_NS) &&
+ (!is_string($namespace))) {
+ //TypeError
+ $err_msg = sprintf("Namespace must be Auth_OpenID_BARE_NS, ".
+ "Auth_OpenID_OPENID_NS or a string. got %s",
+ print_r($namespace, true));
+ return new Auth_OpenID_FailureResponse(null, $err_msg);
+ }
+
+ if (($namespace != Auth_OpenID_BARE_NS) &&
+ (strpos($namespace, ':') === false)) {
+ // fmt = 'OpenID 2.0 namespace identifiers SHOULD be URIs. Got %r'
+ // warnings.warn(fmt % (namespace,), DeprecationWarning)
+
+ if ($namespace == 'sreg') {
+ // fmt = 'Using %r instead of "sreg" as namespace'
+ // warnings.warn(fmt % (SREG_URI,), DeprecationWarning,)
+ return Auth_OpenID_SREG_URI;
+ }
+ }
+
+ return $namespace;
+ }
+
+ function hasKey($namespace, $ns_key)
+ {
+ $namespace = $this->_fixNS($namespace);
+ if (Auth_OpenID::isFailure($namespace)) {
+ // XXX log me
+ return false;
+ } else {
+ return $this->args->contains(array($namespace, $ns_key));
+ }
+ }
+
+ function getKey($namespace, $ns_key)
+ {
+ // Get the key for a particular namespaced argument
+ $namespace = $this->_fixNS($namespace);
+ if (Auth_OpenID::isFailure($namespace)) {
+ return $namespace;
+ }
+ if ($namespace == Auth_OpenID_BARE_NS) {
+ return $ns_key;
+ }
+
+ $ns_alias = $this->namespaces->getAlias($namespace);
+
+ // No alias is defined, so no key can exist
+ if ($ns_alias === null) {
+ return null;
+ }
+
+ if ($ns_alias == Auth_OpenID_NULL_NAMESPACE) {
+ $tail = $ns_key;
+ } else {
+ $tail = sprintf('%s.%s', $ns_alias, $ns_key);
+ }
+
+ return 'openid.' . $tail;
+ }
+
+ function getArg($namespace, $key, $default = null)
+ {
+ // Get a value for a namespaced key.
+ $namespace = $this->_fixNS($namespace);
+
+ if (Auth_OpenID::isFailure($namespace)) {
+ return $namespace;
+ } else {
+ if ((!$this->args->contains(array($namespace, $key))) &&
+ ($default == Auth_OpenID_NO_DEFAULT)) {
+ $err_msg = sprintf("Namespace %s missing required field %s",
+ $namespace, $key);
+ return new Auth_OpenID_FailureResponse(null, $err_msg);
+ } else {
+ return $this->args->get(array($namespace, $key), $default);
+ }
+ }
+ }
+
+ function getArgs($namespace)
+ {
+ // Get the arguments that are defined for this namespace URI
+
+ $namespace = $this->_fixNS($namespace);
+ if (Auth_OpenID::isFailure($namespace)) {
+ return $namespace;
+ } else {
+ $stuff = array();
+ foreach ($this->args->items() as $pair) {
+ list($key, $value) = $pair;
+ list($pair_ns, $ns_key) = $key;
+ if ($pair_ns == $namespace) {
+ $stuff[$ns_key] = $value;
+ }
+ }
+
+ return $stuff;
+ }
+ }
+
+ function updateArgs($namespace, $updates)
+ {
+ // Set multiple key/value pairs in one call
+
+ $namespace = $this->_fixNS($namespace);
+
+ if (Auth_OpenID::isFailure($namespace)) {
+ return $namespace;
+ } else {
+ foreach ($updates as $k => $v) {
+ $this->setArg($namespace, $k, $v);
+ }
+ return true;
+ }
+ }
+
+ function setArg($namespace, $key, $value)
+ {
+ // Set a single argument in this namespace
+ $namespace = $this->_fixNS($namespace);
+
+ if (Auth_OpenID::isFailure($namespace)) {
+ return $namespace;
+ } else {
+ $this->args->set(array($namespace, $key), $value);
+ if ($namespace !== Auth_OpenID_BARE_NS) {
+ $this->namespaces->add($namespace);
+ }
+ return true;
+ }
+ }
+
+ function delArg($namespace, $key)
+ {
+ $namespace = $this->_fixNS($namespace);
+
+ if (Auth_OpenID::isFailure($namespace)) {
+ return $namespace;
+ } else {
+ return $this->args->del(array($namespace, $key));
+ }
+ }
+
+ function getAliasedArg($aliased_key, $default = null)
+ {
+ if ($aliased_key == 'ns') {
+ // Return the namespace URI for the OpenID namespace
+ return $this->getOpenIDNamespace();
+ }
+
+ $parts = explode('.', $aliased_key, 2);
+
+ if (count($parts) != 2) {
+ $ns = null;
+ } else {
+ list($alias, $key) = $parts;
+
+ if ($alias == 'ns') {
+ // Return the namespace URI for a namespace alias
+ // parameter.
+ return $this->namespaces->getNamespaceURI($key);
+ } else {
+ $ns = $this->namespaces->getNamespaceURI($alias);
+ }
+ }
+
+ if ($ns === null) {
+ $key = $aliased_key;
+ $ns = $this->getOpenIDNamespace();
+ }
+
+ return $this->getArg($ns, $key, $default);
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/MySQLStore.php
@@ -1,1 +1,78 @@
+<?php
+/**
+ * A MySQL store.
+ *
+ * @package OpenID
+ */
+
+/**
+ * Require the base class file.
+ */
+require_once "Auth/OpenID/SQLStore.php";
+
+/**
+ * An SQL store that uses MySQL as its backend.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_MySQLStore extends Auth_OpenID_SQLStore {
+ /**
+ * @access private
+ */
+ function setSQL()
+ {
+ $this->sql['nonce_table'] =
+ "CREATE TABLE %s (\n".
+ " server_url VARCHAR(2047) NOT NULL,\n".
+ " timestamp INTEGER NOT NULL,\n".
+ " salt CHAR(40) NOT NULL,\n".
+ " UNIQUE (server_url(255), timestamp, salt)\n".
+ ") ENGINE=InnoDB";
+
+ $this->sql['assoc_table'] =
+ "CREATE TABLE %s (\n".
+ " server_url BLOB NOT NULL,\n".
+ " handle VARCHAR(255) NOT NULL,\n".
+ " secret BLOB NOT NULL,\n".
+ " issued INTEGER NOT NULL,\n".
+ " lifetime INTEGER NOT NULL,\n".
+ " assoc_type VARCHAR(64) NOT NULL,\n".
+ " PRIMARY KEY (server_url(255), handle)\n".
+ ") ENGINE=InnoDB";
+
+ $this->sql['set_assoc'] =
+ "REPLACE INTO %s (server_url, handle, secret, issued,\n".
+ " lifetime, assoc_type) VALUES (?, ?, !, ?, ?, ?)";
+
+ $this->sql['get_assocs'] =
+ "SELECT handle, secret, issued, lifetime, assoc_type FROM %s ".
+ "WHERE server_url = ?";
+
+ $this->sql['get_assoc'] =
+ "SELECT handle, secret, issued, lifetime, assoc_type FROM %s ".
+ "WHERE server_url = ? AND handle = ?";
+
+ $this->sql['remove_assoc'] =
+ "DELETE FROM %s WHERE server_url = ? AND handle = ?";
+
+ $this->sql['add_nonce'] =
+ "INSERT INTO %s (server_url, timestamp, salt) VALUES (?, ?, ?)";
+
+ $this->sql['clean_nonce'] =
+ "DELETE FROM %s WHERE timestamp < ?";
+
+ $this->sql['clean_assoc'] =
+ "DELETE FROM %s WHERE issued + lifetime < ?";
+ }
+
+ /**
+ * @access private
+ */
+ function blobEncode($blob)
+ {
+ return "0x" . bin2hex($blob);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Nonce.php
@@ -1,1 +1,109 @@
+<?php
+/**
+ * Nonce-related functionality.
+ *
+ * @package OpenID
+ */
+
+/**
+ * Need CryptUtil to generate random strings.
+ */
+require_once 'Auth/OpenID/CryptUtil.php';
+
+/**
+ * This is the characters that the nonces are made from.
+ */
+define('Auth_OpenID_Nonce_CHRS',"abcdefghijklmnopqrstuvwxyz" .
+ "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");
+
+// Keep nonces for five hours (allow five hours for the combination of
+// request time and clock skew). This is probably way more than is
+// necessary, but there is not much overhead in storing nonces.
+global $Auth_OpenID_SKEW;
+$Auth_OpenID_SKEW = 60 * 60 * 5;
+
+define('Auth_OpenID_Nonce_REGEX',
+ '/(\d{4})-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)Z(.*)/');
+
+define('Auth_OpenID_Nonce_TIME_FMT',
+ '%Y-%m-%dT%H:%M:%SZ');
+
+function Auth_OpenID_splitNonce($nonce_string)
+{
+ // Extract a timestamp from the given nonce string
+ $result = preg_match(Auth_OpenID_Nonce_REGEX, $nonce_string, $matches);
+ if ($result != 1 || count($matches) != 8) {
+ return null;
+ }
+
+ list($unused,
+ $tm_year,
+ $tm_mon,
+ $tm_mday,
+ $tm_hour,
+ $tm_min,
+ $tm_sec,
+ $uniquifier) = $matches;
+
+ $timestamp =
+ @gmmktime($tm_hour, $tm_min, $tm_sec, $tm_mon, $tm_mday, $tm_year);
+
+ if ($timestamp === false || $timestamp < 0) {
+ return null;
+ }
+
+ return array($timestamp, $uniquifier);
+}
+
+function Auth_OpenID_checkTimestamp($nonce_string,
+ $allowed_skew = null,
+ $now = null)
+{
+ // Is the timestamp that is part of the specified nonce string
+ // within the allowed clock-skew of the current time?
+ global $Auth_OpenID_SKEW;
+
+ if ($allowed_skew === null) {
+ $allowed_skew = $Auth_OpenID_SKEW;
+ }
+
+ $parts = Auth_OpenID_splitNonce($nonce_string);
+ if ($parts == null) {
+ return false;
+ }
+
+ if ($now === null) {
+ $now = time();
+ }
+
+ $stamp = $parts[0];
+
+ // Time after which we should not use the nonce
+ $past = $now - $allowed_skew;
+
+ // Time that is too far in the future for us to allow
+ $future = $now + $allowed_skew;
+
+ // the stamp is not too far in the future and is not too far
+ // in the past
+ return (($past <= $stamp) && ($stamp <= $future));
+}
+
+function Auth_OpenID_mkNonce($when = null)
+{
+ // Generate a nonce with the current timestamp
+ $salt = Auth_OpenID_CryptUtil::randomString(
+ 6, Auth_OpenID_Nonce_CHRS);
+ if ($when === null) {
+ // It's safe to call time() with no arguments; it returns a
+ // GMT unix timestamp on PHP 4 and PHP 5. gmmktime() with no
+ // args returns a local unix timestamp on PHP 4, so don't use
+ // that.
+ $when = time();
+ }
+ $time_str = gmstrftime(Auth_OpenID_Nonce_TIME_FMT, $when);
+ return $time_str . $salt;
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/PAPE.php
@@ -1,1 +1,301 @@
-
+<?php
+
+/**
+ * An implementation of the OpenID Provider Authentication Policy
+ * Extension 1.0
+ *
+ * See:
+ * http://openid.net/developers/specs/
+ */
+
+require_once "Auth/OpenID/Extension.php";
+
+define('Auth_OpenID_PAPE_NS_URI',
+ "http://specs.openid.net/extensions/pape/1.0");
+
+define('PAPE_AUTH_MULTI_FACTOR_PHYSICAL',
+ 'http://schemas.openid.net/pape/policies/2007/06/multi-factor-physical');
+define('PAPE_AUTH_MULTI_FACTOR',
+ 'http://schemas.openid.net/pape/policies/2007/06/multi-factor');
+define('PAPE_AUTH_PHISHING_RESISTANT',
+ 'http://schemas.openid.net/pape/policies/2007/06/phishing-resistant');
+
+define('PAPE_TIME_VALIDATOR',
+ '/^[0-9]{4,4}-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]Z$/');
+/**
+ * A Provider Authentication Policy request, sent from a relying party
+ * to a provider
+ *
+ * preferred_auth_policies: The authentication policies that
+ * the relying party prefers
+ *
+ * max_auth_age: The maximum time, in seconds, that the relying party
+ * wants to allow to have elapsed before the user must re-authenticate
+ */
+class Auth_OpenID_PAPE_Request extends Auth_OpenID_Extension {
+
+ var $ns_alias = 'pape';
+ var $ns_uri = Auth_OpenID_PAPE_NS_URI;
+
+ function Auth_OpenID_PAPE_Request($preferred_auth_policies=null,
+ $max_auth_age=null)
+ {
+ if ($preferred_auth_policies === null) {
+ $preferred_auth_policies = array();
+ }
+
+ $this->preferred_auth_policies = $preferred_auth_policies;
+ $this->max_auth_age = $max_auth_age;
+ }
+
+ /**
+ * Add an acceptable authentication policy URI to this request
+ *
+ * This method is intended to be used by the relying party to add
+ * acceptable authentication types to the request.
+ *
+ * policy_uri: The identifier for the preferred type of
+ * authentication.
+ */
+ function addPolicyURI($policy_uri)
+ {
+ if (!in_array($policy_uri, $this->preferred_auth_policies)) {
+ $this->preferred_auth_policies[] = $policy_uri;
+ }
+ }
+
+ function getExtensionArgs()
+ {
+ $ns_args = array(
+ 'preferred_auth_policies' =>
+ implode(' ', $this->preferred_auth_policies)
+ );
+
+ if ($this->max_auth_age !== null) {
+ $ns_args['max_auth_age'] = strval($this->max_auth_age);
+ }
+
+ return $ns_args;
+ }
+
+ /**
+ * Instantiate a Request object from the arguments in a checkid_*
+ * OpenID message
+ */
+ static function fromOpenIDRequest($request)
+ {
+ $obj = new Auth_OpenID_PAPE_Request();
+ $args = $request->message->getArgs(Auth_OpenID_PAPE_NS_URI);
+
+ if ($args === null || $args === array()) {
+ return null;
+ }
+
+ $obj->parseExtensionArgs($args);
+ return $obj;
+ }
+
+ /**
+ * Set the state of this request to be that expressed in these
+ * PAPE arguments
+ *
+ * @param args: The PAPE arguments without a namespace
+ */
+ function parseExtensionArgs($args)
+ {
+ // preferred_auth_policies is a space-separated list of policy
+ // URIs
+ $this->preferred_auth_policies = array();
+
+ $policies_str = Auth_OpenID::arrayGet($args, 'preferred_auth_policies');
+ if ($policies_str) {
+ foreach (explode(' ', $policies_str) as $uri) {
+ if (!in_array($uri, $this->preferred_auth_policies)) {
+ $this->preferred_auth_policies[] = $uri;
+ }
+ }
+ }
+
+ // max_auth_age is base-10 integer number of seconds
+ $max_auth_age_str = Auth_OpenID::arrayGet($args, 'max_auth_age');
+ if ($max_auth_age_str) {
+ $this->max_auth_age = Auth_OpenID::intval($max_auth_age_str);
+ } else {
+ $this->max_auth_age = null;
+ }
+ }
+
+ /**
+ * Given a list of authentication policy URIs that a provider
+ * supports, this method returns the subsequence of those types
+ * that are preferred by the relying party.
+ *
+ * @param supported_types: A sequence of authentication policy
+ * type URIs that are supported by a provider
+ *
+ * @return array The sub-sequence of the supported types that are
+ * preferred by the relying party. This list will be ordered in
+ * the order that the types appear in the supported_types
+ * sequence, and may be empty if the provider does not prefer any
+ * of the supported authentication types.
+ */
+ function preferredTypes($supported_types)
+ {
+ $result = array();
+
+ foreach ($supported_types as $st) {
+ if (in_array($st, $this->preferred_auth_policies)) {
+ $result[] = $st;
+ }
+ }
+ return $result;
+ }
+}
+
+/**
+ * A Provider Authentication Policy response, sent from a provider to
+ * a relying party
+ */
+class Auth_OpenID_PAPE_Response extends Auth_OpenID_Extension {
+
+ var $ns_alias = 'pape';
+ var $ns_uri = Auth_OpenID_PAPE_NS_URI;
+
+ function Auth_OpenID_PAPE_Response($auth_policies=null, $auth_time=null,
+ $nist_auth_level=null)
+ {
+ if ($auth_policies) {
+ $this->auth_policies = $auth_policies;
+ } else {
+ $this->auth_policies = array();
+ }
+
+ $this->auth_time = $auth_time;
+ $this->nist_auth_level = $nist_auth_level;
+ }
+
+ /**
+ * Add a authentication policy to this response
+ *
+ * This method is intended to be used by the provider to add a
+ * policy that the provider conformed to when authenticating the
+ * user.
+ *
+ * @param policy_uri: The identifier for the preferred type of
+ * authentication.
+ */
+ function addPolicyURI($policy_uri)
+ {
+ if (!in_array($policy_uri, $this->auth_policies)) {
+ $this->auth_policies[] = $policy_uri;
+ }
+ }
+
+ /**
+ * Create an Auth_OpenID_PAPE_Response object from a successful
+ * OpenID library response.
+ *
+ * @param success_response $success_response A SuccessResponse
+ * from Auth_OpenID_Consumer::complete()
+ *
+ * @returns: A provider authentication policy response from the
+ * data that was supplied with the id_res response.
+ */
+ static function fromSuccessResponse($success_response)
+ {
+ $obj = new Auth_OpenID_PAPE_Response();
+
+ // PAPE requires that the args be signed.
+ $args = $success_response->getSignedNS(Auth_OpenID_PAPE_NS_URI);
+
+ if ($args === null || $args === array()) {
+ return null;
+ }
+
+ $result = $obj->parseExtensionArgs($args);
+
+ if ($result === false) {
+ return null;
+ } else {
+ return $obj;
+ }
+ }
+
+ /**
+ * Parse the provider authentication policy arguments into the
+ * internal state of this object
+ *
+ * @param args: unqualified provider authentication policy
+ * arguments
+ *
+ * @param strict: Whether to return false when bad data is
+ * encountered
+ *
+ * @return null The data is parsed into the internal fields of
+ * this object.
+ */
+ function parseExtensionArgs($args, $strict=false)
+ {
+ $policies_str = Auth_OpenID::arrayGet($args, 'auth_policies');
+ if ($policies_str && $policies_str != "none") {
+ $this->auth_policies = explode(" ", $policies_str);
+ }
+
+ $nist_level_str = Auth_OpenID::arrayGet($args, 'nist_auth_level');
+ if ($nist_level_str !== null) {
+ $nist_level = Auth_OpenID::intval($nist_level_str);
+
+ if ($nist_level === false) {
+ if ($strict) {
+ return false;
+ } else {
+ $nist_level = null;
+ }
+ }
+
+ if (0 <= $nist_level && $nist_level < 5) {
+ $this->nist_auth_level = $nist_level;
+ } else if ($strict) {
+ return false;
+ }
+ }
+
+ $auth_time = Auth_OpenID::arrayGet($args, 'auth_time');
+ if ($auth_time !== null) {
+ if (preg_match(PAPE_TIME_VALIDATOR, $auth_time)) {
+ $this->auth_time = $auth_time;
+ } else if ($strict) {
+ return false;
+ }
+ }
+ }
+
+ function getExtensionArgs()
+ {
+ $ns_args = array();
+ if (count($this->auth_policies) > 0) {
+ $ns_args['auth_policies'] = implode(' ', $this->auth_policies);
+ } else {
+ $ns_args['auth_policies'] = 'none';
+ }
+
+ if ($this->nist_auth_level !== null) {
+ if (!in_array($this->nist_auth_level, range(0, 4), true)) {
+ return false;
+ }
+ $ns_args['nist_auth_level'] = strval($this->nist_auth_level);
+ }
+
+ if ($this->auth_time !== null) {
+ if (!preg_match(PAPE_TIME_VALIDATOR, $this->auth_time)) {
+ return false;
+ }
+
+ $ns_args['auth_time'] = $this->auth_time;
+ }
+
+ return $ns_args;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Parse.php
@@ -1,1 +1,378 @@
-
+<?php
+
+/**
+ * This module implements a VERY limited parser that finds <link> tags
+ * in the head of HTML or XHTML documents and parses out their
+ * attributes according to the OpenID spec. It is a liberal parser,
+ * but it requires these things from the data in order to work:
+ *
+ * - There must be an open <html> tag
+ *
+ * - There must be an open <head> tag inside of the <html> tag
+ *
+ * - Only <link>s that are found inside of the <head> tag are parsed
+ * (this is by design)
+ *
+ * - The parser follows the OpenID specification in resolving the
+ * attributes of the link tags. This means that the attributes DO
+ * NOT get resolved as they would by an XML or HTML parser. In
+ * particular, only certain entities get replaced, and href
+ * attributes do not get resolved relative to a base URL.
+ *
+ * From http://openid.net/specs.bml:
+ *
+ * - The openid.server URL MUST be an absolute URL. OpenID consumers
+ * MUST NOT attempt to resolve relative URLs.
+ *
+ * - The openid.server URL MUST NOT include entities other than &,
+ * <, >, and ".
+ *
+ * The parser ignores SGML comments and <![CDATA[blocks]]>. Both kinds
+ * of quoting are allowed for attributes.
+ *
+ * The parser deals with invalid markup in these ways:
+ *
+ * - Tag names are not case-sensitive
+ *
+ * - The <html> tag is accepted even when it is not at the top level
+ *
+ * - The <head> tag is accepted even when it is not a direct child of
+ * the <html> tag, but a <html> tag must be an ancestor of the
+ * <head> tag
+ *
+ * - <link> tags are accepted even when they are not direct children
+ * of the <head> tag, but a <head> tag must be an ancestor of the
+ * <link> tag
+ *
+ * - If there is no closing tag for an open <html> or <head> tag, the
+ * remainder of the document is viewed as being inside of the
+ * tag. If there is no closing tag for a <link> tag, the link tag is
+ * treated as a short tag. Exceptions to this rule are that <html>
+ * closes <html> and <body> or <head> closes <head>
+ *
+ * - Attributes of the <link> tag are not required to be quoted.
+ *
+ * - In the case of duplicated attribute names, the attribute coming
+ * last in the tag will be the value returned.
+ *
+ * - Any text that does not parse as an attribute within a link tag
+ * will be ignored. (e.g. <link pumpkin rel='openid.server' /> will
+ * ignore pumpkin)
+ *
+ * - If there are more than one <html> or <head> tag, the parser only
+ * looks inside of the first one.
+ *
+ * - The contents of <script> tags are ignored entirely, except
+ * unclosed <script> tags. Unclosed <script> tags are ignored.
+ *
+ * - Any other invalid markup is ignored, including unclosed SGML
+ * comments and unclosed <![CDATA[blocks.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @access private
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Require Auth_OpenID::arrayGet().
+ */
+require_once "Auth/OpenID.php";
+
+class Auth_OpenID_Parse {
+
+ /**
+ * Specify some flags for use with regex matching.
+ */
+ var $_re_flags = "si";
+
+ /**
+ * Stuff to remove before we start looking for tags
+ */
+ var $_removed_re =
+ "<!--.*?-->|<!\[CDATA\[.*?\]\]>|<script\b(?!:)[^>]*>.*?<\/script>";
+
+ /**
+ * Starts with the tag name at a word boundary, where the tag name
+ * is not a namespace
+ */
+ var $_tag_expr = "<%s\b(?!:)([^>]*?)(?:\/>|>(.*)(?:<\/?%s\s*>|\Z))";
+
+ var $_attr_find = '\b(\w+)=("[^"]*"|\'[^\']*\'|[^\'"\s\/<>]+)';
+
+ var $_open_tag_expr = "<%s\b";
+ var $_close_tag_expr = "<((\/%s\b)|(%s[^>\/]*\/))>";
+
+ function Auth_OpenID_Parse()
+ {
+ $this->_link_find = sprintf("/<link\b(?!:)([^>]*)(?!<)>/%s",
+ $this->_re_flags);
+
+ $this->_entity_replacements = array(
+ 'amp' => '&',
+ 'lt' => '<',
+ 'gt' => '>',
+ 'quot' => '"'
+ );
+
+ $this->_attr_find = sprintf("/%s/%s",
+ $this->_attr_find,
+ $this->_re_flags);
+
+ $this->_removed_re = sprintf("/%s/%s",
+ $this->_removed_re,
+ $this->_re_flags);
+
+ $this->_ent_replace =
+ sprintf("&(%s);", implode("|",
+ $this->_entity_replacements));
+ }
+
+ /**
+ * Returns a regular expression that will match a given tag in an
+ * SGML string.
+ */
+ function tagMatcher($tag_name, $close_tags = null)
+ {
+ $expr = $this->_tag_expr;
+
+ if ($close_tags) {
+ $options = implode("|", array_merge(array($tag_name), $close_tags));
+ $closer = sprintf("(?:%s)", $options);
+ } else {
+ $closer = $tag_name;
+ }
+
+ $expr = sprintf($expr, $tag_name, $closer);
+ return sprintf("/%s/%s", $expr, $this->_re_flags);
+ }
+
+ function openTag($tag_name)
+ {
+ $expr = sprintf($this->_open_tag_expr, $tag_name);
+ return sprintf("/%s/%s", $expr, $this->_re_flags);
+ }
+
+ function closeTag($tag_name)
+ {
+ $expr = sprintf($this->_close_tag_expr, $tag_name, $tag_name);
+ return sprintf("/%s/%s", $expr, $this->_re_flags);
+ }
+
+ function htmlBegin($s)
+ {
+ $matches = array();
+ $result = preg_match($this->openTag('html'), $s,
+ $matches, PREG_OFFSET_CAPTURE);
+ if ($result === false || !$matches) {
+ return false;
+ }
+ // Return the offset of the first match.
+ return $matches[0][1];
+ }
+
+ function htmlEnd($s)
+ {
+ $matches = array();
+ $result = preg_match($this->closeTag('html'), $s,
+ $matches, PREG_OFFSET_CAPTURE);
+ if ($result === false || !$matches) {
+ return false;
+ }
+ // Return the offset of the first match.
+ return $matches[count($matches) - 1][1];
+ }
+
+ function headFind()
+ {
+ return $this->tagMatcher('head', array('body', 'html'));
+ }
+
+ function replaceEntities($str)
+ {
+ foreach ($this->_entity_replacements as $old => $new) {
+ $str = preg_replace(sprintf("/&%s;/", $old), $new, $str);
+ }
+ return $str;
+ }
+
+ function removeQuotes($str)
+ {
+ $matches = array();
+ $double = '/^"(.*)"$/';
+ $single = "/^\'(.*)\'$/";
+
+ if (preg_match($double, $str, $matches)) {
+ return $matches[1];
+ } else if (preg_match($single, $str, $matches)) {
+ return $matches[1];
+ } else {
+ return $str;
+ }
+ }
+
+ function match($regexp, $text, &$match)
+ {
+ if (!is_callable('mb_ereg_search_init')) {
+ return preg_match($regexp, $text, $match);
+ }
+
+ $regexp = substr($regexp, 1, strlen($regexp) - 2 - strlen($this->_re_flags));
+ mb_ereg_search_init($text);
+ if (!mb_ereg_search($regexp)) {
+ return false;
+ }
+ $match = mb_ereg_search_getregs();
+ return true;
+ }
+
+ /**
+ * Find all link tags in a string representing a HTML document and
+ * return a list of their attributes.
+ *
+ * @todo This is quite ineffective and may fail with the default
+ * pcre.backtrack_limit of 100000 in PHP 5.2, if $html is big.
+ * It should rather use stripos (in PHP5) or strpos()+strtoupper()
+ * in PHP4 to manage this.
+ *
+ * @param string $html The text to parse
+ * @return array $list An array of arrays of attributes, one for each
+ * link tag
+ */
+ function parseLinkAttrs($html)
+ {
+ $stripped = preg_replace($this->_removed_re,
+ "",
+ $html);
+
+ $html_begin = $this->htmlBegin($stripped);
+ $html_end = $this->htmlEnd($stripped);
+
+ if ($html_begin === false) {
+ return array();
+ }
+
+ if ($html_end === false) {
+ $html_end = strlen($stripped);
+ }
+
+ $stripped = substr($stripped, $html_begin,
+ $html_end - $html_begin);
+
+ // Workaround to prevent PREG_BACKTRACK_LIMIT_ERROR:
+ $old_btlimit = ini_set( 'pcre.backtrack_limit', -1 );
+
+ // Try to find the <HEAD> tag.
+ $head_re = $this->headFind();
+ $head_match = array();
+ if (!$this->match($head_re, $stripped, $head_match)) {
+ ini_set( 'pcre.backtrack_limit', $old_btlimit );
+ return array();
+ }
+
+ $link_data = array();
+ $link_matches = array();
+
+ if (!preg_match_all($this->_link_find, $head_match[0],
+ $link_matches)) {
+ ini_set( 'pcre.backtrack_limit', $old_btlimit );
+ return array();
+ }
+
+ foreach ($link_matches[0] as $link) {
+ $attr_matches = array();
+ preg_match_all($this->_attr_find, $link, $attr_matches);
+ $link_attrs = array();
+ foreach ($attr_matches[0] as $index => $full_match) {
+ $name = $attr_matches[1][$index];
+ $value = $this->replaceEntities(
+ $this->removeQuotes($attr_matches[2][$index]));
+
+ $link_attrs[strtolower($name)] = $value;
+ }
+ $link_data[] = $link_attrs;
+ }
+
+ ini_set( 'pcre.backtrack_limit', $old_btlimit );
+ return $link_data;
+ }
+
+ function relMatches($rel_attr, $target_rel)
+ {
+ // Does this target_rel appear in the rel_str?
+ // XXX: TESTME
+ $rels = preg_split("/\s+/", trim($rel_attr));
+ foreach ($rels as $rel) {
+ $rel = strtolower($rel);
+ if ($rel == $target_rel) {
+ return 1;
+ }
+ }
+
+ return 0;
+ }
+
+ function linkHasRel($link_attrs, $target_rel)
+ {
+ // Does this link have target_rel as a relationship?
+ // XXX: TESTME
+ $rel_attr = Auth_OpeniD::arrayGet($link_attrs, 'rel', null);
+ return ($rel_attr && $this->relMatches($rel_attr,
+ $target_rel));
+ }
+
+ function findLinksRel($link_attrs_list, $target_rel)
+ {
+ // Filter the list of link attributes on whether it has
+ // target_rel as a relationship.
+ // XXX: TESTME
+ $result = array();
+ foreach ($link_attrs_list as $attr) {
+ if ($this->linkHasRel($attr, $target_rel)) {
+ $result[] = $attr;
+ }
+ }
+
+ return $result;
+ }
+
+ function findFirstHref($link_attrs_list, $target_rel)
+ {
+ // Return the value of the href attribute for the first link
+ // tag in the list that has target_rel as a relationship.
+ // XXX: TESTME
+ $matches = $this->findLinksRel($link_attrs_list,
+ $target_rel);
+ if (!$matches) {
+ return null;
+ }
+ $first = $matches[0];
+ return Auth_OpenID::arrayGet($first, 'href', null);
+ }
+}
+
+function Auth_OpenID_legacy_discover($html_text, $server_rel,
+ $delegate_rel)
+{
+ $p = new Auth_OpenID_Parse();
+
+ $link_attrs = $p->parseLinkAttrs($html_text);
+
+ $server_url = $p->findFirstHref($link_attrs,
+ $server_rel);
+
+ if ($server_url === null) {
+ return false;
+ } else {
+ $delegate_url = $p->findFirstHref($link_attrs,
+ $delegate_rel);
+ return array($delegate_url, $server_url);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/PostgreSQLStore.php
@@ -1,1 +1,113 @@
+<?php
+/**
+ * A PostgreSQL store.
+ *
+ * @package OpenID
+ */
+
+/**
+ * Require the base class file.
+ */
+require_once "Auth/OpenID/SQLStore.php";
+
+/**
+ * An SQL store that uses PostgreSQL as its backend.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_PostgreSQLStore extends Auth_OpenID_SQLStore {
+ /**
+ * @access private
+ */
+ function setSQL()
+ {
+ $this->sql['nonce_table'] =
+ "CREATE TABLE %s (server_url VARCHAR(2047) NOT NULL, ".
+ "timestamp INTEGER NOT NULL, ".
+ "salt CHAR(40) NOT NULL, ".
+ "UNIQUE (server_url, timestamp, salt))";
+
+ $this->sql['assoc_table'] =
+ "CREATE TABLE %s (server_url VARCHAR(2047) NOT NULL, ".
+ "handle VARCHAR(255) NOT NULL, ".
+ "secret BYTEA NOT NULL, ".
+ "issued INTEGER NOT NULL, ".
+ "lifetime INTEGER NOT NULL, ".
+ "assoc_type VARCHAR(64) NOT NULL, ".
+ "PRIMARY KEY (server_url, handle), ".
+ "CONSTRAINT secret_length_constraint CHECK ".
+ "(LENGTH(secret) <= 128))";
+
+ $this->sql['set_assoc'] =
+ array(
+ 'insert_assoc' => "INSERT INTO %s (server_url, handle, ".
+ "secret, issued, lifetime, assoc_type) VALUES ".
+ "(?, ?, '!', ?, ?, ?)",
+ 'update_assoc' => "UPDATE %s SET secret = '!', issued = ?, ".
+ "lifetime = ?, assoc_type = ? WHERE server_url = ? AND ".
+ "handle = ?"
+ );
+
+ $this->sql['get_assocs'] =
+ "SELECT handle, secret, issued, lifetime, assoc_type FROM %s ".
+ "WHERE server_url = ?";
+
+ $this->sql['get_assoc'] =
+ "SELECT handle, secret, issued, lifetime, assoc_type FROM %s ".
+ "WHERE server_url = ? AND handle = ?";
+
+ $this->sql['remove_assoc'] =
+ "DELETE FROM %s WHERE server_url = ? AND handle = ?";
+
+ $this->sql['add_nonce'] =
+ "INSERT INTO %s (server_url, timestamp, salt) VALUES ".
+ "(?, ?, ?)"
+ ;
+
+ $this->sql['clean_nonce'] =
+ "DELETE FROM %s WHERE timestamp < ?";
+
+ $this->sql['clean_assoc'] =
+ "DELETE FROM %s WHERE issued + lifetime < ?";
+ }
+
+ /**
+ * @access private
+ */
+ function _set_assoc($server_url, $handle, $secret, $issued, $lifetime,
+ $assoc_type)
+ {
+ $result = $this->_get_assoc($server_url, $handle);
+ if ($result) {
+ // Update the table since this associations already exists.
+ $this->connection->query($this->sql['set_assoc']['update_assoc'],
+ array($secret, $issued, $lifetime,
+ $assoc_type, $server_url, $handle));
+ } else {
+ // Insert a new record because this association wasn't
+ // found.
+ $this->connection->query($this->sql['set_assoc']['insert_assoc'],
+ array($server_url, $handle, $secret,
+ $issued, $lifetime, $assoc_type));
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function blobEncode($blob)
+ {
+ return $this->_octify($blob);
+ }
+
+ /**
+ * @access private
+ */
+ function blobDecode($blob)
+ {
+ return $this->_unoctify($blob);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/SQLStore.php
@@ -1,1 +1,558 @@
-
+<?php
+
+/**
+ * SQL-backed OpenID stores.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/Interface.php';
+require_once 'Auth/OpenID/Nonce.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID.php';
+
+/**
+ * @access private
+ */
+require_once 'Auth/OpenID/Nonce.php';
+
+/**
+ * This is the parent class for the SQL stores, which contains the
+ * logic common to all of the SQL stores.
+ *
+ * The table names used are determined by the class variables
+ * associations_table_name and nonces_table_name. To change the name
+ * of the tables used, pass new table names into the constructor.
+ *
+ * To create the tables with the proper schema, see the createTables
+ * method.
+ *
+ * This class shouldn't be used directly. Use one of its subclasses
+ * instead, as those contain the code necessary to use a specific
+ * database. If you're an OpenID integrator and you'd like to create
+ * an SQL-driven store that wraps an application's database
+ * abstraction, be sure to create a subclass of
+ * {@link Auth_OpenID_DatabaseConnection} that calls the application's
+ * database abstraction calls. Then, pass an instance of your new
+ * database connection class to your SQLStore subclass constructor.
+ *
+ * All methods other than the constructor and createTables should be
+ * considered implementation details.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SQLStore extends Auth_OpenID_OpenIDStore {
+
+ /**
+ * This creates a new SQLStore instance. It requires an
+ * established database connection be given to it, and it allows
+ * overriding the default table names.
+ *
+ * @param connection $connection This must be an established
+ * connection to a database of the correct type for the SQLStore
+ * subclass you're using. This must either be an PEAR DB
+ * connection handle or an instance of a subclass of
+ * Auth_OpenID_DatabaseConnection.
+ *
+ * @param associations_table: This is an optional parameter to
+ * specify the name of the table used for storing associations.
+ * The default value is 'oid_associations'.
+ *
+ * @param nonces_table: This is an optional parameter to specify
+ * the name of the table used for storing nonces. The default
+ * value is 'oid_nonces'.
+ */
+ function Auth_OpenID_SQLStore($connection,
+ $associations_table = null,
+ $nonces_table = null)
+ {
+ $this->associations_table_name = "oid_associations";
+ $this->nonces_table_name = "oid_nonces";
+
+ // Check the connection object type to be sure it's a PEAR
+ // database connection.
+ if (!(is_object($connection) &&
+ (is_subclass_of($connection, 'db_common') ||
+ is_subclass_of($connection,
+ 'auth_openid_databaseconnection')))) {
+ trigger_error("Auth_OpenID_SQLStore expected PEAR connection " .
+ "object (got ".get_class($connection).")",
+ E_USER_ERROR);
+ return;
+ }
+
+ $this->connection = $connection;
+
+ // Be sure to set the fetch mode so the results are keyed on
+ // column name instead of column index. This is a PEAR
+ // constant, so only try to use it if PEAR is present. Note
+ // that Auth_Openid_Databaseconnection instances need not
+ // implement ::setFetchMode for this reason.
+ if (is_subclass_of($this->connection, 'db_common')) {
+ $this->connection->setFetchMode(DB_FETCHMODE_ASSOC);
+ }
+
+ if ($associations_table) {
+ $this->associations_table_name = $associations_table;
+ }
+
+ if ($nonces_table) {
+ $this->nonces_table_name = $nonces_table;
+ }
+
+ $this->max_nonce_age = 6 * 60 * 60;
+
+ // Be sure to run the database queries with auto-commit mode
+ // turned OFF, because we want every function to run in a
+ // transaction, implicitly. As a rule, methods named with a
+ // leading underscore will NOT control transaction behavior.
+ // Callers of these methods will worry about transactions.
+ $this->connection->autoCommit(false);
+
+ // Create an empty SQL strings array.
+ $this->sql = array();
+
+ // Call this method (which should be overridden by subclasses)
+ // to populate the $this->sql array with SQL strings.
+ $this->setSQL();
+
+ // Verify that all required SQL statements have been set, and
+ // raise an error if any expected SQL strings were either
+ // absent or empty.
+ list($missing, $empty) = $this->_verifySQL();
+
+ if ($missing) {
+ trigger_error("Expected keys in SQL query list: " .
+ implode(", ", $missing),
+ E_USER_ERROR);
+ return;
+ }
+
+ if ($empty) {
+ trigger_error("SQL list keys have no SQL strings: " .
+ implode(", ", $empty),
+ E_USER_ERROR);
+ return;
+ }
+
+ // Add table names to queries.
+ $this->_fixSQL();
+ }
+
+ function tableExists($table_name)
+ {
+ return !$this->isError(
+ $this->connection->query(
+ sprintf("SELECT * FROM %s LIMIT 0",
+ $table_name)));
+ }
+
+ /**
+ * Returns true if $value constitutes a database error; returns
+ * false otherwise.
+ */
+ function isError($value)
+ {
+ return PEAR::isError($value);
+ }
+
+ /**
+ * Converts a query result to a boolean. If the result is a
+ * database error according to $this->isError(), this returns
+ * false; otherwise, this returns true.
+ */
+ function resultToBool($obj)
+ {
+ if ($this->isError($obj)) {
+ return false;
+ } else {
+ return true;
+ }
+ }
+
+ /**
+ * This method should be overridden by subclasses. This method is
+ * called by the constructor to set values in $this->sql, which is
+ * an array keyed on sql name.
+ */
+ function setSQL()
+ {
+ }
+
+ /**
+ * Resets the store by removing all records from the store's
+ * tables.
+ */
+ function reset()
+ {
+ $this->connection->query(sprintf("DELETE FROM %s",
+ $this->associations_table_name));
+
+ $this->connection->query(sprintf("DELETE FROM %s",
+ $this->nonces_table_name));
+ }
+
+ /**
+ * @access private
+ */
+ function _verifySQL()
+ {
+ $missing = array();
+ $empty = array();
+
+ $required_sql_keys = array(
+ 'nonce_table',
+ 'assoc_table',
+ 'set_assoc',
+ 'get_assoc',
+ 'get_assocs',
+ 'remove_assoc'
+ );
+
+ foreach ($required_sql_keys as $key) {
+ if (!array_key_exists($key, $this->sql)) {
+ $missing[] = $key;
+ } else if (!$this->sql[$key]) {
+ $empty[] = $key;
+ }
+ }
+
+ return array($missing, $empty);
+ }
+
+ /**
+ * @access private
+ */
+ function _fixSQL()
+ {
+ $replacements = array(
+ array(
+ 'value' => $this->nonces_table_name,
+ 'keys' => array('nonce_table',
+ 'add_nonce',
+ 'clean_nonce')
+ ),
+ array(
+ 'value' => $this->associations_table_name,
+ 'keys' => array('assoc_table',
+ 'set_assoc',
+ 'get_assoc',
+ 'get_assocs',
+ 'remove_assoc',
+ 'clean_assoc')
+ )
+ );
+
+ foreach ($replacements as $item) {
+ $value = $item['value'];
+ $keys = $item['keys'];
+
+ foreach ($keys as $k) {
+ if (is_array($this->sql[$k])) {
+ foreach ($this->sql[$k] as $part_key => $part_value) {
+ $this->sql[$k][$part_key] = sprintf($part_value,
+ $value);
+ }
+ } else {
+ $this->sql[$k] = sprintf($this->sql[$k], $value);
+ }
+ }
+ }
+ }
+
+ function blobDecode($blob)
+ {
+ return $blob;
+ }
+
+ function blobEncode($str)
+ {
+ return $str;
+ }
+
+ function createTables()
+ {
+ $this->connection->autoCommit(true);
+ $n = $this->create_nonce_table();
+ $a = $this->create_assoc_table();
+ $this->connection->autoCommit(false);
+
+ if ($n && $a) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ function create_nonce_table()
+ {
+ if (!$this->tableExists($this->nonces_table_name)) {
+ $r = $this->connection->query($this->sql['nonce_table']);
+ return $this->resultToBool($r);
+ }
+ return true;
+ }
+
+ function create_assoc_table()
+ {
+ if (!$this->tableExists($this->associations_table_name)) {
+ $r = $this->connection->query($this->sql['assoc_table']);
+ return $this->resultToBool($r);
+ }
+ return true;
+ }
+
+ /**
+ * @access private
+ */
+ function _set_assoc($server_url, $handle, $secret, $issued,
+ $lifetime, $assoc_type)
+ {
+ return $this->connection->query($this->sql['set_assoc'],
+ array(
+ $server_url,
+ $handle,
+ $secret,
+ $issued,
+ $lifetime,
+ $assoc_type));
+ }
+
+ function storeAssociation($server_url, $association)
+ {
+ if ($this->resultToBool($this->_set_assoc(
+ $server_url,
+ $association->handle,
+ $this->blobEncode(
+ $association->secret),
+ $association->issued,
+ $association->lifetime,
+ $association->assoc_type
+ ))) {
+ $this->connection->commit();
+ } else {
+ $this->connection->rollback();
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _get_assoc($server_url, $handle)
+ {
+ $result = $this->connection->getRow($this->sql['get_assoc'],
+ array($server_url, $handle));
+ if ($this->isError($result)) {
+ return null;
+ } else {
+ return $result;
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _get_assocs($server_url)
+ {
+ $result = $this->connection->getAll($this->sql['get_assocs'],
+ array($server_url));
+
+ if ($this->isError($result)) {
+ return array();
+ } else {
+ return $result;
+ }
+ }
+
+ function removeAssociation($server_url, $handle)
+ {
+ if ($this->_get_assoc($server_url, $handle) == null) {
+ return false;
+ }
+
+ if ($this->resultToBool($this->connection->query(
+ $this->sql['remove_assoc'],
+ array($server_url, $handle)))) {
+ $this->connection->commit();
+ } else {
+ $this->connection->rollback();
+ }
+
+ return true;
+ }
+
+ function getAssociation($server_url, $handle = null)
+ {
+ if ($handle !== null) {
+ $assoc = $this->_get_assoc($server_url, $handle);
+
+ $assocs = array();
+ if ($assoc) {
+ $assocs[] = $assoc;
+ }
+ } else {
+ $assocs = $this->_get_assocs($server_url);
+ }
+
+ if (!$assocs || (count($assocs) == 0)) {
+ return null;
+ } else {
+ $associations = array();
+
+ foreach ($assocs as $assoc_row) {
+ $assoc = new Auth_OpenID_Association($assoc_row['handle'],
+ $assoc_row['secret'],
+ $assoc_row['issued'],
+ $assoc_row['lifetime'],
+ $assoc_row['assoc_type']);
+
+ $assoc->secret = $this->blobDecode($assoc->secret);
+
+ if ($assoc->getExpiresIn() == 0) {
+ $this->removeAssociation($server_url, $assoc->handle);
+ } else {
+ $associations[] = array($assoc->issued, $assoc);
+ }
+ }
+
+ if ($associations) {
+ $issued = array();
+ $assocs = array();
+ foreach ($associations as $key => $assoc) {
+ $issued[$key] = $assoc[0];
+ $assocs[$key] = $assoc[1];
+ }
+
+ array_multisort($issued, SORT_DESC, $assocs, SORT_DESC,
+ $associations);
+
+ // return the most recently issued one.
+ list($issued, $assoc) = $associations[0];
+ return $assoc;
+ } else {
+ return null;
+ }
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function _add_nonce($server_url, $timestamp, $salt)
+ {
+ $sql = $this->sql['add_nonce'];
+ $result = $this->connection->query($sql, array($server_url,
+ $timestamp,
+ $salt));
+ if ($this->isError($result)) {
+ $this->connection->rollback();
+ } else {
+ $this->connection->commit();
+ }
+ return $this->resultToBool($result);
+ }
+
+ function useNonce($server_url, $timestamp, $salt)
+ {
+ global $Auth_OpenID_SKEW;
+
+ if ( abs($timestamp - time()) > $Auth_OpenID_SKEW ) {
+ return false;
+ }
+
+ return $this->_add_nonce($server_url, $timestamp, $salt);
+ }
+
+ /**
+ * "Octifies" a binary string by returning a string with escaped
+ * octal bytes. This is used for preparing binary data for
+ * PostgreSQL BYTEA fields.
+ *
+ * @access private
+ */
+ function _octify($str)
+ {
+ $result = "";
+ for ($i = 0; $i < Auth_OpenID::bytes($str); $i++) {
+ $ch = substr($str, $i, 1);
+ if ($ch == "\\") {
+ $result .= "\\\\\\\\";
+ } else if (ord($ch) == 0) {
+ $result .= "\\\\000";
+ } else {
+ $result .= "\\" . strval(decoct(ord($ch)));
+ }
+ }
+ return $result;
+ }
+
+ /**
+ * "Unoctifies" octal-escaped data from PostgreSQL and returns the
+ * resulting ASCII (possibly binary) string.
+ *
+ * @access private
+ */
+ function _unoctify($str)
+ {
+ $result = "";
+ $i = 0;
+ while ($i < strlen($str)) {
+ $char = $str[$i];
+ if ($char == "\\") {
+ // Look to see if the next char is a backslash and
+ // append it.
+ if ($str[$i + 1] != "\\") {
+ $octal_digits = substr($str, $i + 1, 3);
+ $dec = octdec($octal_digits);
+ $char = chr($dec);
+ $i += 4;
+ } else {
+ $char = "\\";
+ $i += 2;
+ }
+ } else {
+ $i += 1;
+ }
+
+ $result .= $char;
+ }
+
+ return $result;
+ }
+
+ function cleanupNonces()
+ {
+ global $Auth_OpenID_SKEW;
+ $v = time() - $Auth_OpenID_SKEW;
+
+ $this->connection->query($this->sql['clean_nonce'], array($v));
+ $num = $this->connection->affectedRows();
+ $this->connection->commit();
+ return $num;
+ }
+
+ function cleanupAssociations()
+ {
+ $this->connection->query($this->sql['clean_assoc'],
+ array(time()));
+ $num = $this->connection->affectedRows();
+ $this->connection->commit();
+ return $num;
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/SQLiteStore.php
@@ -1,1 +1,71 @@
+<?php
+/**
+ * An SQLite store.
+ *
+ * @package OpenID
+ */
+
+/**
+ * Require the base class file.
+ */
+require_once "Auth/OpenID/SQLStore.php";
+
+/**
+ * An SQL store that uses SQLite as its backend.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SQLiteStore extends Auth_OpenID_SQLStore {
+ function setSQL()
+ {
+ $this->sql['nonce_table'] =
+ "CREATE TABLE %s (server_url VARCHAR(2047), timestamp INTEGER, ".
+ "salt CHAR(40), UNIQUE (server_url, timestamp, salt))";
+
+ $this->sql['assoc_table'] =
+ "CREATE TABLE %s (server_url VARCHAR(2047), handle VARCHAR(255), ".
+ "secret BLOB(128), issued INTEGER, lifetime INTEGER, ".
+ "assoc_type VARCHAR(64), PRIMARY KEY (server_url, handle))";
+
+ $this->sql['set_assoc'] =
+ "INSERT OR REPLACE INTO %s VALUES (?, ?, ?, ?, ?, ?)";
+
+ $this->sql['get_assocs'] =
+ "SELECT handle, secret, issued, lifetime, assoc_type FROM %s ".
+ "WHERE server_url = ?";
+
+ $this->sql['get_assoc'] =
+ "SELECT handle, secret, issued, lifetime, assoc_type FROM %s ".
+ "WHERE server_url = ? AND handle = ?";
+
+ $this->sql['remove_assoc'] =
+ "DELETE FROM %s WHERE server_url = ? AND handle = ?";
+
+ $this->sql['add_nonce'] =
+ "INSERT INTO %s (server_url, timestamp, salt) VALUES (?, ?, ?)";
+
+ $this->sql['clean_nonce'] =
+ "DELETE FROM %s WHERE timestamp < ?";
+
+ $this->sql['clean_assoc'] =
+ "DELETE FROM %s WHERE issued + lifetime < ?";
+ }
+
+ /**
+ * @access private
+ */
+ function _add_nonce($server_url, $timestamp, $salt)
+ {
+ // PECL SQLite extensions 1.0.3 and older (1.0.3 is the
+ // current release at the time of this writing) have a broken
+ // sqlite_escape_string function that breaks when passed the
+ // empty string. Prefixing all strings with one character
+ // keeps them unique and avoids this bug. The nonce table is
+ // write-only, so we don't have to worry about updating other
+ // functions with this same bad hack.
+ return parent::_add_nonce('x' . $server_url, $timestamp, $salt);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/SReg.php
@@ -1,1 +1,522 @@
-
+<?php
+
+/**
+ * Simple registration request and response parsing and object
+ * representation.
+ *
+ * This module contains objects representing simple registration
+ * requests and responses that can be used with both OpenID relying
+ * parties and OpenID providers.
+ *
+ * 1. The relying party creates a request object and adds it to the
+ * {@link Auth_OpenID_AuthRequest} object before making the
+ * checkid request to the OpenID provider:
+ *
+ * $sreg_req = Auth_OpenID_SRegRequest::build(array('email'));
+ * $auth_request->addExtension($sreg_req);
+ *
+ * 2. The OpenID provider extracts the simple registration request
+ * from the OpenID request using {@link
+ * Auth_OpenID_SRegRequest::fromOpenIDRequest}, gets the user's
+ * approval and data, creates an {@link Auth_OpenID_SRegResponse}
+ * object and adds it to the id_res response:
+ *
+ * $sreg_req = Auth_OpenID_SRegRequest::fromOpenIDRequest(
+ * $checkid_request);
+ * // [ get the user's approval and data, informing the user that
+ * // the fields in sreg_response were requested ]
+ * $sreg_resp = Auth_OpenID_SRegResponse::extractResponse(
+ * $sreg_req, $user_data);
+ * $sreg_resp->toMessage($openid_response->fields);
+ *
+ * 3. The relying party uses {@link
+ * Auth_OpenID_SRegResponse::fromSuccessResponse} to extract the data
+ * from the OpenID response:
+ *
+ * $sreg_resp = Auth_OpenID_SRegResponse::fromSuccessResponse(
+ * $success_response);
+ *
+ * @package OpenID
+ */
+
+/**
+ * Import message and extension internals.
+ */
+require_once 'Auth/OpenID/Message.php';
+require_once 'Auth/OpenID/Extension.php';
+
+// The data fields that are listed in the sreg spec
+global $Auth_OpenID_sreg_data_fields;
+$Auth_OpenID_sreg_data_fields = array(
+ 'fullname' => 'Full Name',
+ 'nickname' => 'Nickname',
+ 'dob' => 'Date of Birth',
+ 'email' => 'E-mail Address',
+ 'gender' => 'Gender',
+ 'postcode' => 'Postal Code',
+ 'country' => 'Country',
+ 'language' => 'Language',
+ 'timezone' => 'Time Zone');
+
+/**
+ * Check to see that the given value is a valid simple registration
+ * data field name. Return true if so, false if not.
+ */
+function Auth_OpenID_checkFieldName($field_name)
+{
+ global $Auth_OpenID_sreg_data_fields;
+
+ if (!in_array($field_name, array_keys($Auth_OpenID_sreg_data_fields))) {
+ return false;
+ }
+ return true;
+}
+
+// URI used in the wild for Yadis documents advertising simple
+// registration support
+define('Auth_OpenID_SREG_NS_URI_1_0', 'http://openid.net/sreg/1.0');
+
+// URI in the draft specification for simple registration 1.1
+// <http://openid.net/specs/openid-simple-registration-extension-1_1-01.html>
+define('Auth_OpenID_SREG_NS_URI_1_1', 'http://openid.net/extensions/sreg/1.1');
+
+// This attribute will always hold the preferred URI to use when
+// adding sreg support to an XRDS file or in an OpenID namespace
+// declaration.
+define('Auth_OpenID_SREG_NS_URI', Auth_OpenID_SREG_NS_URI_1_1);
+
+Auth_OpenID_registerNamespaceAlias(Auth_OpenID_SREG_NS_URI_1_1, 'sreg');
+
+/**
+ * Does the given endpoint advertise support for simple
+ * registration?
+ *
+ * $endpoint: The endpoint object as returned by OpenID discovery.
+ * returns whether an sreg type was advertised by the endpoint
+ */
+function Auth_OpenID_supportsSReg($endpoint)
+{
+ return ($endpoint->usesExtension(Auth_OpenID_SREG_NS_URI_1_1) ||
+ $endpoint->usesExtension(Auth_OpenID_SREG_NS_URI_1_0));
+}
+
+/**
+ * A base class for classes dealing with Simple Registration protocol
+ * messages.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SRegBase extends Auth_OpenID_Extension {
+ /**
+ * Extract the simple registration namespace URI from the given
+ * OpenID message. Handles OpenID 1 and 2, as well as both sreg
+ * namespace URIs found in the wild, as well as missing namespace
+ * definitions (for OpenID 1)
+ *
+ * $message: The OpenID message from which to parse simple
+ * registration fields. This may be a request or response message.
+ *
+ * Returns the sreg namespace URI for the supplied message. The
+ * message may be modified to define a simple registration
+ * namespace.
+ *
+ * @access private
+ */
+ static function _getSRegNS($message)
+ {
+ $alias = null;
+ $found_ns_uri = null;
+
+ // See if there exists an alias for one of the two defined
+ // simple registration types.
+ foreach (array(Auth_OpenID_SREG_NS_URI_1_1,
+ Auth_OpenID_SREG_NS_URI_1_0) as $sreg_ns_uri) {
+ $alias = $message->namespaces->getAlias($sreg_ns_uri);
+ if ($alias !== null) {
+ $found_ns_uri = $sreg_ns_uri;
+ break;
+ }
+ }
+
+ if ($alias === null) {
+ // There is no alias for either of the types, so try to
+ // add one. We default to using the modern value (1.1)
+ $found_ns_uri = Auth_OpenID_SREG_NS_URI_1_1;
+ if ($message->namespaces->addAlias(Auth_OpenID_SREG_NS_URI_1_1,
+ 'sreg') === null) {
+ // An alias for the string 'sreg' already exists, but
+ // it's defined for something other than simple
+ // registration
+ return null;
+ }
+ }
+
+ return $found_ns_uri;
+ }
+}
+
+/**
+ * An object to hold the state of a simple registration request.
+ *
+ * required: A list of the required fields in this simple registration
+ * request
+ *
+ * optional: A list of the optional fields in this simple registration
+ * request
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SRegRequest extends Auth_OpenID_SRegBase {
+
+ var $ns_alias = 'sreg';
+
+ /**
+ * Initialize an empty simple registration request.
+ */
+ static function build($required=null, $optional=null,
+ $policy_url=null,
+ $sreg_ns_uri=Auth_OpenID_SREG_NS_URI,
+ $cls='Auth_OpenID_SRegRequest')
+ {
+ $obj = new $cls();
+
+ $obj->required = array();
+ $obj->optional = array();
+ $obj->policy_url = $policy_url;
+ $obj->ns_uri = $sreg_ns_uri;
+
+ if ($required) {
+ if (!$obj->requestFields($required, true, true)) {
+ return null;
+ }
+ }
+
+ if ($optional) {
+ if (!$obj->requestFields($optional, false, true)) {
+ return null;
+ }
+ }
+
+ return $obj;
+ }
+
+ /**
+ * Create a simple registration request that contains the fields
+ * that were requested in the OpenID request with the given
+ * arguments
+ *
+ * $request: The OpenID authentication request from which to
+ * extract an sreg request.
+ *
+ * $cls: name of class to use when creating sreg request object.
+ * Used for testing.
+ *
+ * Returns the newly created simple registration request
+ */
+ static function fromOpenIDRequest($request, $cls='Auth_OpenID_SRegRequest')
+ {
+
+ $obj = call_user_func_array(array($cls, 'build'),
+ array(null, null, null, Auth_OpenID_SREG_NS_URI, $cls));
+
+ // Since we're going to mess with namespace URI mapping, don't
+ // mutate the object that was passed in.
+ $m = $request->message;
+
+ $obj->ns_uri = $obj->_getSRegNS($m);
+ $args = $m->getArgs($obj->ns_uri);
+
+ if ($args === null || Auth_OpenID::isFailure($args)) {
+ return null;
+ }
+
+ $obj->parseExtensionArgs($args);
+
+ return $obj;
+ }
+
+ /**
+ * Parse the unqualified simple registration request parameters
+ * and add them to this object.
+ *
+ * This method is essentially the inverse of
+ * getExtensionArgs. This method restores the serialized simple
+ * registration request fields.
+ *
+ * If you are extracting arguments from a standard OpenID
+ * checkid_* request, you probably want to use fromOpenIDRequest,
+ * which will extract the sreg namespace and arguments from the
+ * OpenID request. This method is intended for cases where the
+ * OpenID server needs more control over how the arguments are
+ * parsed than that method provides.
+ *
+ * $args == $message->getArgs($ns_uri);
+ * $request->parseExtensionArgs($args);
+ *
+ * $args: The unqualified simple registration arguments
+ *
+ * strict: Whether requests with fields that are not defined in
+ * the simple registration specification should be tolerated (and
+ * ignored)
+ */
+ function parseExtensionArgs($args, $strict=false)
+ {
+ foreach (array('required', 'optional') as $list_name) {
+ $required = ($list_name == 'required');
+ $items = Auth_OpenID::arrayGet($args, $list_name);
+ if ($items) {
+ foreach (explode(',', $items) as $field_name) {
+ if (!$this->requestField($field_name, $required, $strict)) {
+ if ($strict) {
+ return false;
+ }
+ }
+ }
+ }
+ }
+
+ $this->policy_url = Auth_OpenID::arrayGet($args, 'policy_url');
+
+ return true;
+ }
+
+ /**
+ * A list of all of the simple registration fields that were
+ * requested, whether they were required or optional.
+ */
+ function allRequestedFields()
+ {
+ return array_merge($this->required, $this->optional);
+ }
+
+ /**
+ * Have any simple registration fields been requested?
+ */
+ function wereFieldsRequested()
+ {
+ return count($this->allRequestedFields());
+ }
+
+ /**
+ * Was this field in the request?
+ */
+ function contains($field_name)
+ {
+ return (in_array($field_name, $this->required) ||
+ in_array($field_name, $this->optional));
+ }
+
+ /**
+ * Request the specified field from the OpenID user
+ *
+ * $field_name: the unqualified simple registration field name
+ *
+ * required: whether the given field should be presented to the
+ * user as being a required to successfully complete the request
+ *
+ * strict: whether to raise an exception when a field is added to
+ * a request more than once
+ */
+ function requestField($field_name,
+ $required=false, $strict=false)
+ {
+ if (!Auth_OpenID_checkFieldName($field_name)) {
+ return false;
+ }
+
+ if ($strict) {
+ if ($this->contains($field_name)) {
+ return false;
+ }
+ } else {
+ if (in_array($field_name, $this->required)) {
+ return true;
+ }
+
+ if (in_array($field_name, $this->optional)) {
+ if ($required) {
+ unset($this->optional[array_search($field_name,
+ $this->optional)]);
+ } else {
+ return true;
+ }
+ }
+ }
+
+ if ($required) {
+ $this->required[] = $field_name;
+ } else {
+ $this->optional[] = $field_name;
+ }
+
+ return true;
+ }
+
+ /**
+ * Add the given list of fields to the request
+ *
+ * field_names: The simple registration data fields to request
+ *
+ * required: Whether these values should be presented to the user
+ * as required
+ *
+ * strict: whether to raise an exception when a field is added to
+ * a request more than once
+ */
+ function requestFields($field_names, $required=false, $strict=false)
+ {
+ if (!is_array($field_names)) {
+ return false;
+ }
+
+ foreach ($field_names as $field_name) {
+ if (!$this->requestField($field_name, $required, $strict=$strict)) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Get a dictionary of unqualified simple registration arguments
+ * representing this request.
+ *
+ * This method is essentially the inverse of
+ * C{L{parseExtensionArgs}}. This method serializes the simple
+ * registration request fields.
+ */
+ function getExtensionArgs()
+ {
+ $args = array();
+
+ if ($this->required) {
+ $args['required'] = implode(',', $this->required);
+ }
+
+ if ($this->optional) {
+ $args['optional'] = implode(',', $this->optional);
+ }
+
+ if ($this->policy_url) {
+ $args['policy_url'] = $this->policy_url;
+ }
+
+ return $args;
+ }
+}
+
+/**
+ * Represents the data returned in a simple registration response
+ * inside of an OpenID C{id_res} response. This object will be created
+ * by the OpenID server, added to the C{id_res} response object, and
+ * then extracted from the C{id_res} message by the Consumer.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SRegResponse extends Auth_OpenID_SRegBase {
+
+ var $ns_alias = 'sreg';
+
+ function Auth_OpenID_SRegResponse($data=null,
+ $sreg_ns_uri=Auth_OpenID_SREG_NS_URI)
+ {
+ if ($data === null) {
+ $this->data = array();
+ } else {
+ $this->data = $data;
+ }
+
+ $this->ns_uri = $sreg_ns_uri;
+ }
+
+ /**
+ * Take a C{L{SRegRequest}} and a dictionary of simple
+ * registration values and create a C{L{SRegResponse}} object
+ * containing that data.
+ *
+ * request: The simple registration request object
+ *
+ * data: The simple registration data for this response, as a
+ * dictionary from unqualified simple registration field name to
+ * string (unicode) value. For instance, the nickname should be
+ * stored under the key 'nickname'.
+ */
+ static function extractResponse($request, $data)
+ {
+ $obj = new Auth_OpenID_SRegResponse();
+ $obj->ns_uri = $request->ns_uri;
+
+ foreach ($request->allRequestedFields() as $field) {
+ $value = Auth_OpenID::arrayGet($data, $field);
+ if ($value !== null) {
+ $obj->data[$field] = $value;
+ }
+ }
+
+ return $obj;
+ }
+
+ /**
+ * Create a C{L{SRegResponse}} object from a successful OpenID
+ * library response
+ * (C{L{openid.consumer.consumer.SuccessResponse}}) response
+ * message
+ *
+ * success_response: A SuccessResponse from consumer.complete()
+ *
+ * signed_only: Whether to process only data that was
+ * signed in the id_res message from the server.
+ *
+ * Returns a simple registration response containing the data that
+ * was supplied with the C{id_res} response.
+ */
+ static function fromSuccessResponse($success_response, $signed_only=true)
+ {
+ global $Auth_OpenID_sreg_data_fields;
+
+ $obj = new Auth_OpenID_SRegResponse();
+ $obj->ns_uri = $obj->_getSRegNS($success_response->message);
+
+ if ($signed_only) {
+ $args = $success_response->getSignedNS($obj->ns_uri);
+ } else {
+ $args = $success_response->message->getArgs($obj->ns_uri);
+ }
+
+ if ($args === null || Auth_OpenID::isFailure($args)) {
+ return null;
+ }
+
+ foreach ($Auth_OpenID_sreg_data_fields as $field_name => $desc) {
+ if (in_array($field_name, array_keys($args))) {
+ $obj->data[$field_name] = $args[$field_name];
+ }
+ }
+
+ return $obj;
+ }
+
+ function getExtensionArgs()
+ {
+ return $this->data;
+ }
+
+ // Read-only dictionary interface
+ function get($field_name, $default=null)
+ {
+ if (!Auth_OpenID_checkFieldName($field_name)) {
+ return null;
+ }
+
+ return Auth_OpenID::arrayGet($this->data, $field_name, $default);
+ }
+
+ function contents()
+ {
+ return $this->data;
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/Server.php
@@ -1,1 +1,1766 @@
-
+<?php
+
+/**
+ * OpenID server protocol and logic.
+ *
+ * Overview
+ *
+ * An OpenID server must perform three tasks:
+ *
+ * 1. Examine the incoming request to determine its nature and validity.
+ * 2. Make a decision about how to respond to this request.
+ * 3. Format the response according to the protocol.
+ *
+ * The first and last of these tasks may performed by the {@link
+ * Auth_OpenID_Server::decodeRequest()} and {@link
+ * Auth_OpenID_Server::encodeResponse} methods. Who gets to do the
+ * intermediate task -- deciding how to respond to the request -- will
+ * depend on what type of request it is.
+ *
+ * If it's a request to authenticate a user (a 'checkid_setup' or
+ * 'checkid_immediate' request), you need to decide if you will assert
+ * that this user may claim the identity in question. Exactly how you
+ * do that is a matter of application policy, but it generally
+ * involves making sure the user has an account with your system and
+ * is logged in, checking to see if that identity is hers to claim,
+ * and verifying with the user that she does consent to releasing that
+ * information to the party making the request.
+ *
+ * Examine the properties of the {@link Auth_OpenID_CheckIDRequest}
+ * object, and if and when you've come to a decision, form a response
+ * by calling {@link Auth_OpenID_CheckIDRequest::answer()}.
+ *
+ * Other types of requests relate to establishing associations between
+ * client and server and verifing the authenticity of previous
+ * communications. {@link Auth_OpenID_Server} contains all the logic
+ * and data necessary to respond to such requests; just pass it to
+ * {@link Auth_OpenID_Server::handleRequest()}.
+ *
+ * OpenID Extensions
+ *
+ * Do you want to provide other information for your users in addition
+ * to authentication? Version 1.2 of the OpenID protocol allows
+ * consumers to add extensions to their requests. For example, with
+ * sites using the Simple Registration
+ * Extension
+ * (http://openid.net/specs/openid-simple-registration-extension-1_0.html),
+ * a user can agree to have their nickname and e-mail address sent to
+ * a site when they sign up.
+ *
+ * Since extensions do not change the way OpenID authentication works,
+ * code to handle extension requests may be completely separate from
+ * the {@link Auth_OpenID_Request} class here. But you'll likely want
+ * data sent back by your extension to be signed. {@link
+ * Auth_OpenID_ServerResponse} provides methods with which you can add
+ * data to it which can be signed with the other data in the OpenID
+ * signature.
+ *
+ * For example:
+ *
+ * <pre> // when request is a checkid_* request
+ * $response = $request->answer(true);
+ * // this will a signed 'openid.sreg.timezone' parameter to the response
+ * response.addField('sreg', 'timezone', 'America/Los_Angeles')</pre>
+ *
+ * Stores
+ *
+ * The OpenID server needs to maintain state between requests in order
+ * to function. Its mechanism for doing this is called a store. The
+ * store interface is defined in Interface.php. Additionally, several
+ * concrete store implementations are provided, so that most sites
+ * won't need to implement a custom store. For a store backed by flat
+ * files on disk, see {@link Auth_OpenID_FileStore}. For stores based
+ * on MySQL, SQLite, or PostgreSQL, see the {@link
+ * Auth_OpenID_SQLStore} subclasses.
+ *
+ * Upgrading
+ *
+ * The keys by which a server looks up associations in its store have
+ * changed in version 1.2 of this library. If your store has entries
+ * created from version 1.0 code, you should empty it.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Required imports
+ */
+require_once "Auth/OpenID.php";
+require_once "Auth/OpenID/Association.php";
+require_once "Auth/OpenID/CryptUtil.php";
+require_once "Auth/OpenID/BigMath.php";
+require_once "Auth/OpenID/DiffieHellman.php";
+require_once "Auth/OpenID/KVForm.php";
+require_once "Auth/OpenID/TrustRoot.php";
+require_once "Auth/OpenID/ServerRequest.php";
+require_once "Auth/OpenID/Message.php";
+require_once "Auth/OpenID/Nonce.php";
+
+define('AUTH_OPENID_HTTP_OK', 200);
+define('AUTH_OPENID_HTTP_REDIRECT', 302);
+define('AUTH_OPENID_HTTP_ERROR', 400);
+
+/**
+ * @access private
+ */
+global $_Auth_OpenID_Request_Modes;
+$_Auth_OpenID_Request_Modes = array('checkid_setup',
+ 'checkid_immediate');
+
+/**
+ * @access private
+ */
+define('Auth_OpenID_ENCODE_KVFORM', 'kfvorm');
+
+/**
+ * @access private
+ */
+define('Auth_OpenID_ENCODE_URL', 'URL/redirect');
+
+/**
+ * @access private
+ */
+define('Auth_OpenID_ENCODE_HTML_FORM', 'HTML form');
+
+/**
+ * @access private
+ */
+function Auth_OpenID_isError($obj, $cls = 'Auth_OpenID_ServerError')
+{
+ return is_a($obj, $cls);
+}
+
+/**
+ * An error class which gets instantiated and returned whenever an
+ * OpenID protocol error occurs. Be prepared to use this in place of
+ * an ordinary server response.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_ServerError {
+ /**
+ * @access private
+ */
+ function Auth_OpenID_ServerError($message = null, $text = null,
+ $reference = null, $contact = null)
+ {
+ $this->message = $message;
+ $this->text = $text;
+ $this->contact = $contact;
+ $this->reference = $reference;
+ }
+
+ function getReturnTo()
+ {
+ if ($this->message &&
+ $this->message->hasKey(Auth_OpenID_OPENID_NS, 'return_to')) {
+ return $this->message->getArg(Auth_OpenID_OPENID_NS,
+ 'return_to');
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Returns the return_to URL for the request which caused this
+ * error.
+ */
+ function hasReturnTo()
+ {
+ return $this->getReturnTo() !== null;
+ }
+
+ /**
+ * Encodes this error's response as a URL suitable for
+ * redirection. If the response has no return_to, another
+ * Auth_OpenID_ServerError is returned.
+ */
+ function encodeToURL()
+ {
+ if (!$this->message) {
+ return null;
+ }
+
+ $msg = $this->toMessage();
+ return $msg->toURL($this->getReturnTo());
+ }
+
+ /**
+ * Encodes the response to key-value form. This is a
+ * machine-readable format used to respond to messages which came
+ * directly from the consumer and not through the user-agent. See
+ * the OpenID specification.
+ */
+ function encodeToKVForm()
+ {
+ return Auth_OpenID_KVForm::fromArray(
+ array('mode' => 'error',
+ 'error' => $this->toString()));
+ }
+
+ function toFormMarkup($form_tag_attrs=null)
+ {
+ $msg = $this->toMessage();
+ return $msg->toFormMarkup($this->getReturnTo(), $form_tag_attrs);
+ }
+
+ function toHTML($form_tag_attrs=null)
+ {
+ return Auth_OpenID::autoSubmitHTML(
+ $this->toFormMarkup($form_tag_attrs));
+ }
+
+ function toMessage()
+ {
+ // Generate a Message object for sending to the relying party,
+ // after encoding.
+ $namespace = $this->message->getOpenIDNamespace();
+ $reply = new Auth_OpenID_Message($namespace);
+ $reply->setArg(Auth_OpenID_OPENID_NS, 'mode', 'error');
+ $reply->setArg(Auth_OpenID_OPENID_NS, 'error', $this->toString());
+
+ if ($this->contact !== null) {
+ $reply->setArg(Auth_OpenID_OPENID_NS, 'contact', $this->contact);
+ }
+
+ if ($this->reference !== null) {
+ $reply->setArg(Auth_OpenID_OPENID_NS, 'reference',
+ $this->reference);
+ }
+
+ return $reply;
+ }
+
+ /**
+ * Returns one of Auth_OpenID_ENCODE_URL,
+ * Auth_OpenID_ENCODE_KVFORM, or null, depending on the type of
+ * encoding expected for this error's payload.
+ */
+ function whichEncoding()
+ {
+ global $_Auth_OpenID_Request_Modes;
+
+ if ($this->hasReturnTo()) {
+ if ($this->message->isOpenID2() &&
+ (strlen($this->encodeToURL()) >
+ Auth_OpenID_OPENID1_URL_LIMIT)) {
+ return Auth_OpenID_ENCODE_HTML_FORM;
+ } else {
+ return Auth_OpenID_ENCODE_URL;
+ }
+ }
+
+ if (!$this->message) {
+ return null;
+ }
+
+ $mode = $this->message->getArg(Auth_OpenID_OPENID_NS,
+ 'mode');
+
+ if ($mode) {
+ if (!in_array($mode, $_Auth_OpenID_Request_Modes)) {
+ return Auth_OpenID_ENCODE_KVFORM;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Returns this error message.
+ */
+ function toString()
+ {
+ if ($this->text) {
+ return $this->text;
+ } else {
+ return get_class($this) . " error";
+ }
+ }
+}
+
+/**
+ * Error returned by the server code when a return_to is absent from a
+ * request.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_NoReturnToError extends Auth_OpenID_ServerError {
+ function Auth_OpenID_NoReturnToError($message = null,
+ $text = "No return_to URL available")
+ {
+ parent::Auth_OpenID_ServerError($message, $text);
+ }
+
+ function toString()
+ {
+ return "No return_to available";
+ }
+}
+
+/**
+ * An error indicating that the return_to URL is malformed.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_MalformedReturnURL extends Auth_OpenID_ServerError {
+ function Auth_OpenID_MalformedReturnURL($message, $return_to)
+ {
+ $this->return_to = $return_to;
+ parent::Auth_OpenID_ServerError($message, "malformed return_to URL");
+ }
+}
+
+/**
+ * This error is returned when the trust_root value is malformed.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_MalformedTrustRoot extends Auth_OpenID_ServerError {
+ function Auth_OpenID_MalformedTrustRoot($message = null,
+ $text = "Malformed trust root")
+ {
+ parent::Auth_OpenID_ServerError($message, $text);
+ }
+
+ function toString()
+ {
+ return "Malformed trust root";
+ }
+}
+
+/**
+ * The base class for all server request classes.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Request {
+ var $mode = null;
+}
+
+/**
+ * A request to verify the validity of a previous response.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_CheckAuthRequest extends Auth_OpenID_Request {
+ var $mode = "check_authentication";
+ var $invalidate_handle = null;
+
+ function Auth_OpenID_CheckAuthRequest($assoc_handle, $signed,
+ $invalidate_handle = null)
+ {
+ $this->assoc_handle = $assoc_handle;
+ $this->signed = $signed;
+ if ($invalidate_handle !== null) {
+ $this->invalidate_handle = $invalidate_handle;
+ }
+ $this->namespace = Auth_OpenID_OPENID2_NS;
+ $this->message = null;
+ }
+
+ static function fromMessage($message, $server=null)
+ {
+ $required_keys = array('assoc_handle', 'sig', 'signed');
+
+ foreach ($required_keys as $k) {
+ if (!$message->getArg(Auth_OpenID_OPENID_NS, $k)) {
+ return new Auth_OpenID_ServerError($message,
+ sprintf("%s request missing required parameter %s from \
+ query", "check_authentication", $k));
+ }
+ }
+
+ $assoc_handle = $message->getArg(Auth_OpenID_OPENID_NS, 'assoc_handle');
+ $sig = $message->getArg(Auth_OpenID_OPENID_NS, 'sig');
+
+ $signed_list = $message->getArg(Auth_OpenID_OPENID_NS, 'signed');
+ $signed_list = explode(",", $signed_list);
+
+ $signed = $message;
+ if ($signed->hasKey(Auth_OpenID_OPENID_NS, 'mode')) {
+ $signed->setArg(Auth_OpenID_OPENID_NS, 'mode', 'id_res');
+ }
+
+ $result = new Auth_OpenID_CheckAuthRequest($assoc_handle, $signed);
+ $result->message = $message;
+ $result->sig = $sig;
+ $result->invalidate_handle = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'invalidate_handle');
+ return $result;
+ }
+
+ function answer($signatory)
+ {
+ $is_valid = $signatory->verify($this->assoc_handle, $this->signed);
+
+ // Now invalidate that assoc_handle so it this checkAuth
+ // message cannot be replayed.
+ $signatory->invalidate($this->assoc_handle, true);
+ $response = new Auth_OpenID_ServerResponse($this);
+
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'is_valid',
+ ($is_valid ? "true" : "false"));
+
+ if ($this->invalidate_handle) {
+ $assoc = $signatory->getAssociation($this->invalidate_handle,
+ false);
+ if (!$assoc) {
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'invalidate_handle',
+ $this->invalidate_handle);
+ }
+ }
+ return $response;
+ }
+}
+
+/**
+ * A class implementing plaintext server sessions.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_PlainTextServerSession {
+ /**
+ * An object that knows how to handle association requests with no
+ * session type.
+ */
+ var $session_type = 'no-encryption';
+ var $needs_math = false;
+ var $allowed_assoc_types = array('HMAC-SHA1', 'HMAC-SHA256');
+
+ static function fromMessage($unused_request)
+ {
+ return new Auth_OpenID_PlainTextServerSession();
+ }
+
+ function answer($secret)
+ {
+ return array('mac_key' => base64_encode($secret));
+ }
+}
+
+/**
+ * A class implementing DH-SHA1 server sessions.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_DiffieHellmanSHA1ServerSession {
+ /**
+ * An object that knows how to handle association requests with
+ * the Diffie-Hellman session type.
+ */
+
+ var $session_type = 'DH-SHA1';
+ var $needs_math = true;
+ var $allowed_assoc_types = array('HMAC-SHA1');
+ var $hash_func = 'Auth_OpenID_SHA1';
+
+ function Auth_OpenID_DiffieHellmanSHA1ServerSession($dh, $consumer_pubkey)
+ {
+ $this->dh = $dh;
+ $this->consumer_pubkey = $consumer_pubkey;
+ }
+
+ static function getDH($message)
+ {
+ $dh_modulus = $message->getArg(Auth_OpenID_OPENID_NS, 'dh_modulus');
+ $dh_gen = $message->getArg(Auth_OpenID_OPENID_NS, 'dh_gen');
+
+ if ((($dh_modulus === null) && ($dh_gen !== null)) ||
+ (($dh_gen === null) && ($dh_modulus !== null))) {
+
+ if ($dh_modulus === null) {
+ $missing = 'modulus';
+ } else {
+ $missing = 'generator';
+ }
+
+ return new Auth_OpenID_ServerError($message,
+ 'If non-default modulus or generator is '.
+ 'supplied, both must be supplied. Missing '.
+ $missing);
+ }
+
+ $lib = Auth_OpenID_getMathLib();
+
+ if ($dh_modulus || $dh_gen) {
+ $dh_modulus = $lib->base64ToLong($dh_modulus);
+ $dh_gen = $lib->base64ToLong($dh_gen);
+ if ($lib->cmp($dh_modulus, 0) == 0 ||
+ $lib->cmp($dh_gen, 0) == 0) {
+ return new Auth_OpenID_ServerError(
+ $message, "Failed to parse dh_mod or dh_gen");
+ }
+ $dh = new Auth_OpenID_DiffieHellman($dh_modulus, $dh_gen);
+ } else {
+ $dh = new Auth_OpenID_DiffieHellman();
+ }
+
+ $consumer_pubkey = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'dh_consumer_public');
+ if ($consumer_pubkey === null) {
+ return new Auth_OpenID_ServerError($message,
+ 'Public key for DH-SHA1 session '.
+ 'not found in query');
+ }
+
+ $consumer_pubkey =
+ $lib->base64ToLong($consumer_pubkey);
+
+ if ($consumer_pubkey === false) {
+ return new Auth_OpenID_ServerError($message,
+ "dh_consumer_public is not base64");
+ }
+
+ return array($dh, $consumer_pubkey);
+ }
+
+ static function fromMessage($message)
+ {
+ $result = Auth_OpenID_DiffieHellmanSHA1ServerSession::getDH($message);
+
+ if (is_a($result, 'Auth_OpenID_ServerError')) {
+ return $result;
+ } else {
+ list($dh, $consumer_pubkey) = $result;
+ return new Auth_OpenID_DiffieHellmanSHA1ServerSession($dh,
+ $consumer_pubkey);
+ }
+ }
+
+ function answer($secret)
+ {
+ $lib = Auth_OpenID_getMathLib();
+ $mac_key = $this->dh->xorSecret($this->consumer_pubkey, $secret,
+ $this->hash_func);
+ return array(
+ 'dh_server_public' =>
+ $lib->longToBase64($this->dh->public),
+ 'enc_mac_key' => base64_encode($mac_key));
+ }
+}
+
+/**
+ * A class implementing DH-SHA256 server sessions.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_DiffieHellmanSHA256ServerSession
+ extends Auth_OpenID_DiffieHellmanSHA1ServerSession {
+
+ var $session_type = 'DH-SHA256';
+ var $hash_func = 'Auth_OpenID_SHA256';
+ var $allowed_assoc_types = array('HMAC-SHA256');
+
+ static function fromMessage($message)
+ {
+ $result = Auth_OpenID_DiffieHellmanSHA1ServerSession::getDH($message);
+
+ if (is_a($result, 'Auth_OpenID_ServerError')) {
+ return $result;
+ } else {
+ list($dh, $consumer_pubkey) = $result;
+ return new Auth_OpenID_DiffieHellmanSHA256ServerSession($dh,
+ $consumer_pubkey);
+ }
+ }
+}
+
+/**
+ * A request to associate with the server.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AssociateRequest extends Auth_OpenID_Request {
+ var $mode = "associate";
+
+ static function getSessionClasses()
+ {
+ return array(
+ 'no-encryption' => 'Auth_OpenID_PlainTextServerSession',
+ 'DH-SHA1' => 'Auth_OpenID_DiffieHellmanSHA1ServerSession',
+ 'DH-SHA256' => 'Auth_OpenID_DiffieHellmanSHA256ServerSession');
+ }
+
+ function Auth_OpenID_AssociateRequest($session, $assoc_type)
+ {
+ $this->session = $session;
+ $this->namespace = Auth_OpenID_OPENID2_NS;
+ $this->assoc_type = $assoc_type;
+ }
+
+ static function fromMessage($message, $server=null)
+ {
+ if ($message->isOpenID1()) {
+ $session_type = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'session_type');
+
+ if ($session_type == 'no-encryption') {
+ // oidutil.log('Received OpenID 1 request with a no-encryption '
+ // 'assocaition session type. Continuing anyway.')
+ } else if (!$session_type) {
+ $session_type = 'no-encryption';
+ }
+ } else {
+ $session_type = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'session_type');
+ if ($session_type === null) {
+ return new Auth_OpenID_ServerError($message,
+ "session_type missing from request");
+ }
+ }
+
+ $session_class = Auth_OpenID::arrayGet(
+ Auth_OpenID_AssociateRequest::getSessionClasses(),
+ $session_type);
+
+ if ($session_class === null) {
+ return new Auth_OpenID_ServerError($message,
+ "Unknown session type " .
+ $session_type);
+ }
+
+ $session = call_user_func(array($session_class, 'fromMessage'),
+ $message);
+ if (is_a($session, 'Auth_OpenID_ServerError')) {
+ return $session;
+ }
+
+ $assoc_type = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'assoc_type', 'HMAC-SHA1');
+
+ if (!in_array($assoc_type, $session->allowed_assoc_types)) {
+ $fmt = "Session type %s does not support association type %s";
+ return new Auth_OpenID_ServerError($message,
+ sprintf($fmt, $session_type, $assoc_type));
+ }
+
+ $obj = new Auth_OpenID_AssociateRequest($session, $assoc_type);
+ $obj->message = $message;
+ $obj->namespace = $message->getOpenIDNamespace();
+ return $obj;
+ }
+
+ function answer($assoc)
+ {
+ $response = new Auth_OpenID_ServerResponse($this);
+ $response->fields->updateArgs(Auth_OpenID_OPENID_NS,
+ array(
+ 'expires_in' => sprintf('%d', $assoc->getExpiresIn()),
+ 'assoc_type' => $this->assoc_type,
+ 'assoc_handle' => $assoc->handle));
+
+ $response->fields->updateArgs(Auth_OpenID_OPENID_NS,
+ $this->session->answer($assoc->secret));
+
+ if (! ($this->session->session_type == 'no-encryption'
+ && $this->message->isOpenID1())) {
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'session_type',
+ $this->session->session_type);
+ }
+
+ return $response;
+ }
+
+ function answerUnsupported($text_message,
+ $preferred_association_type=null,
+ $preferred_session_type=null)
+ {
+ if ($this->message->isOpenID1()) {
+ return new Auth_OpenID_ServerError($this->message);
+ }
+
+ $response = new Auth_OpenID_ServerResponse($this);
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'error_code', 'unsupported-type');
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'error', $text_message);
+
+ if ($preferred_association_type) {
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'assoc_type',
+ $preferred_association_type);
+ }
+
+ if ($preferred_session_type) {
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'session_type',
+ $preferred_session_type);
+ }
+ $response->code = AUTH_OPENID_HTTP_ERROR;
+ return $response;
+ }
+}
+
+/**
+ * A request to confirm the identity of a user.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_CheckIDRequest extends Auth_OpenID_Request {
+ /**
+ * Return-to verification callback. Default is
+ * Auth_OpenID_verifyReturnTo from TrustRoot.php.
+ */
+ var $verifyReturnTo = 'Auth_OpenID_verifyReturnTo';
+
+ /**
+ * The mode of this request.
+ */
+ var $mode = "checkid_setup"; // or "checkid_immediate"
+
+ /**
+ * Whether this request is for immediate mode.
+ */
+ var $immediate = false;
+
+ /**
+ * The trust_root value for this request.
+ */
+ var $trust_root = null;
+
+ /**
+ * The OpenID namespace for this request.
+ * deprecated since version 2.0.2
+ */
+ var $namespace;
+
+ static function make($message, $identity, $return_to, $trust_root = null,
+ $immediate = false, $assoc_handle = null, $server = null)
+ {
+ if ($server === null) {
+ return new Auth_OpenID_ServerError($message,
+ "server must not be null");
+ }
+
+ if ($return_to &&
+ !Auth_OpenID_TrustRoot::_parse($return_to)) {
+ return new Auth_OpenID_MalformedReturnURL($message, $return_to);
+ }
+
+ $r = new Auth_OpenID_CheckIDRequest($identity, $return_to,
+ $trust_root, $immediate,
+ $assoc_handle, $server);
+
+ $r->namespace = $message->getOpenIDNamespace();
+ $r->message = $message;
+
+ if (!$r->trustRootValid()) {
+ return new Auth_OpenID_UntrustedReturnURL($message,
+ $return_to,
+ $trust_root);
+ } else {
+ return $r;
+ }
+ }
+
+ function Auth_OpenID_CheckIDRequest($identity, $return_to,
+ $trust_root = null, $immediate = false,
+ $assoc_handle = null, $server = null,
+ $claimed_id = null)
+ {
+ $this->namespace = Auth_OpenID_OPENID2_NS;
+ $this->assoc_handle = $assoc_handle;
+ $this->identity = $identity;
+ if ($claimed_id === null) {
+ $this->claimed_id = $identity;
+ } else {
+ $this->claimed_id = $claimed_id;
+ }
+ $this->return_to = $return_to;
+ $this->trust_root = $trust_root;
+ $this->server = $server;
+
+ if ($immediate) {
+ $this->immediate = true;
+ $this->mode = "checkid_immediate";
+ } else {
+ $this->immediate = false;
+ $this->mode = "checkid_setup";
+ }
+ }
+
+ function equals($other)
+ {
+ return (
+ (is_a($other, 'Auth_OpenID_CheckIDRequest')) &&
+ ($this->namespace == $other->namespace) &&
+ ($this->assoc_handle == $other->assoc_handle) &&
+ ($this->identity == $other->identity) &&
+ ($this->claimed_id == $other->claimed_id) &&
+ ($this->return_to == $other->return_to) &&
+ ($this->trust_root == $other->trust_root));
+ }
+
+ /*
+ * Does the relying party publish the return_to URL for this
+ * response under the realm? It is up to the provider to set a
+ * policy for what kinds of realms should be allowed. This
+ * return_to URL verification reduces vulnerability to data-theft
+ * attacks based on open proxies, corss-site-scripting, or open
+ * redirectors.
+ *
+ * This check should only be performed after making sure that the
+ * return_to URL matches the realm.
+ *
+ * @return true if the realm publishes a document with the
+ * return_to URL listed, false if not or if discovery fails
+ */
+ function returnToVerified()
+ {
+ $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
+ return call_user_func_array($this->verifyReturnTo,
+ array($this->trust_root, $this->return_to, $fetcher));
+ }
+
+ static function fromMessage($message, $server)
+ {
+ $mode = $message->getArg(Auth_OpenID_OPENID_NS, 'mode');
+ $immediate = null;
+
+ if ($mode == "checkid_immediate") {
+ $immediate = true;
+ $mode = "checkid_immediate";
+ } else {
+ $immediate = false;
+ $mode = "checkid_setup";
+ }
+
+ $return_to = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'return_to');
+
+ if (($message->isOpenID1()) &&
+ (!$return_to)) {
+ $fmt = "Missing required field 'return_to' from checkid request";
+ return new Auth_OpenID_ServerError($message, $fmt);
+ }
+
+ $identity = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'identity');
+ $claimed_id = $message->getArg(Auth_OpenID_OPENID_NS, 'claimed_id');
+ if ($message->isOpenID1()) {
+ if ($identity === null) {
+ $s = "OpenID 1 message did not contain openid.identity";
+ return new Auth_OpenID_ServerError($message, $s);
+ }
+ } else {
+ if ($identity && !$claimed_id) {
+ $s = "OpenID 2.0 message contained openid.identity but not " .
+ "claimed_id";
+ return new Auth_OpenID_ServerError($message, $s);
+ } else if ($claimed_id && !$identity) {
+ $s = "OpenID 2.0 message contained openid.claimed_id " .
+ "but not identity";
+ return new Auth_OpenID_ServerError($message, $s);
+ }
+ }
+
+ // There's a case for making self.trust_root be a TrustRoot
+ // here. But if TrustRoot isn't currently part of the
+ // "public" API, I'm not sure it's worth doing.
+ if ($message->isOpenID1()) {
+ $trust_root_param = 'trust_root';
+ } else {
+ $trust_root_param = 'realm';
+ }
+ $trust_root = $message->getArg(Auth_OpenID_OPENID_NS,
+ $trust_root_param);
+ if (! $trust_root) {
+ $trust_root = $return_to;
+ }
+
+ if (! $message->isOpenID1() &&
+ ($return_to === null) &&
+ ($trust_root === null)) {
+ return new Auth_OpenID_ServerError($message,
+ "openid.realm required when openid.return_to absent");
+ }
+
+ $assoc_handle = $message->getArg(Auth_OpenID_OPENID_NS,
+ 'assoc_handle');
+
+ $obj = Auth_OpenID_CheckIDRequest::make($message,
+ $identity,
+ $return_to,
+ $trust_root,
+ $immediate,
+ $assoc_handle,
+ $server);
+
+ if (is_a($obj, 'Auth_OpenID_ServerError')) {
+ return $obj;
+ }
+
+ $obj->claimed_id = $claimed_id;
+
+ return $obj;
+ }
+
+ function idSelect()
+ {
+ // Is the identifier to be selected by the IDP?
+ // So IDPs don't have to import the constant
+ return $this->identity == Auth_OpenID_IDENTIFIER_SELECT;
+ }
+
+ function trustRootValid()
+ {
+ if (!$this->trust_root) {
+ return true;
+ }
+
+ $tr = Auth_OpenID_TrustRoot::_parse($this->trust_root);
+ if ($tr === false) {
+ return new Auth_OpenID_MalformedTrustRoot($this->message,
+ $this->trust_root);
+ }
+
+ if ($this->return_to !== null) {
+ return Auth_OpenID_TrustRoot::match($this->trust_root,
+ $this->return_to);
+ } else {
+ return true;
+ }
+ }
+
+ /**
+ * Respond to this request. Return either an
+ * {@link Auth_OpenID_ServerResponse} or
+ * {@link Auth_OpenID_ServerError}.
+ *
+ * @param bool $allow Allow this user to claim this identity, and
+ * allow the consumer to have this information?
+ *
+ * @param string $server_url DEPRECATED. Passing $op_endpoint to
+ * the {@link Auth_OpenID_Server} constructor makes this optional.
+ *
+ * When an OpenID 1.x immediate mode request does not succeed, it
+ * gets back a URL where the request may be carried out in a
+ * not-so-immediate fashion. Pass my URL in here (the fully
+ * qualified address of this server's endpoint, i.e.
+ * http://example.com/server), and I will use it as a base for the
+ * URL for a new request.
+ *
+ * Optional for requests where {@link $immediate} is false or
+ * $allow is true.
+ *
+ * @param string $identity The OP-local identifier to answer with.
+ * Only for use when the relying party requested identifier
+ * selection.
+ *
+ * @param string $claimed_id The claimed identifier to answer
+ * with, for use with identifier selection in the case where the
+ * claimed identifier and the OP-local identifier differ,
+ * i.e. when the claimed_id uses delegation.
+ *
+ * If $identity is provided but this is not, $claimed_id will
+ * default to the value of $identity. When answering requests
+ * that did not ask for identifier selection, the response
+ * $claimed_id will default to that of the request.
+ *
+ * This parameter is new in OpenID 2.0.
+ *
+ * @return mixed
+ */
+ function answer($allow, $server_url = null, $identity = null,
+ $claimed_id = null)
+ {
+ if (!$this->return_to) {
+ return new Auth_OpenID_NoReturnToError();
+ }
+
+ if (!$server_url) {
+ if ((!$this->message->isOpenID1()) &&
+ (!$this->server->op_endpoint)) {
+ return new Auth_OpenID_ServerError(null,
+ "server should be constructed with op_endpoint to " .
+ "respond to OpenID 2.0 messages.");
+ }
+
+ $server_url = $this->server->op_endpoint;
+ }
+
+ if ($allow) {
+ $mode = 'id_res';
+ } else if ($this->message->isOpenID1()) {
+ if ($this->immediate) {
+ $mode = 'id_res';
+ } else {
+ $mode = 'cancel';
+ }
+ } else {
+ if ($this->immediate) {
+ $mode = 'setup_needed';
+ } else {
+ $mode = 'cancel';
+ }
+ }
+
+ if (!$this->trustRootValid()) {
+ return new Auth_OpenID_UntrustedReturnURL(null,
+ $this->return_to,
+ $this->trust_root);
+ }
+
+ $response = new Auth_OpenID_ServerResponse($this);
+
+ if ($claimed_id &&
+ ($this->message->isOpenID1())) {
+ return new Auth_OpenID_ServerError(null,
+ "claimed_id is new in OpenID 2.0 and not " .
+ "available for ".$this->namespace);
+ }
+
+ if ($identity && !$claimed_id) {
+ $claimed_id = $identity;
+ }
+
+ if ($allow) {
+
+ if ($this->identity == Auth_OpenID_IDENTIFIER_SELECT) {
+ if (!$identity) {
+ return new Auth_OpenID_ServerError(null,
+ "This request uses IdP-driven identifier selection. " .
+ "You must supply an identifier in the response.");
+ }
+
+ $response_identity = $identity;
+ $response_claimed_id = $claimed_id;
+
+ } else if ($this->identity) {
+ if ($identity &&
+ ($this->identity != $identity)) {
+ $fmt = "Request was for %s, cannot reply with identity %s";
+ return new Auth_OpenID_ServerError(null,
+ sprintf($fmt, $this->identity, $identity));
+ }
+
+ $response_identity = $this->identity;
+ $response_claimed_id = $this->claimed_id;
+ } else {
+ if ($identity) {
+ return new Auth_OpenID_ServerError(null,
+ "This request specified no identity and " .
+ "you supplied ".$identity);
+ }
+
+ $response_identity = null;
+ }
+
+ if (($this->message->isOpenID1()) &&
+ ($response_identity === null)) {
+ return new Auth_OpenID_ServerError(null,
+ "Request was an OpenID 1 request, so response must " .
+ "include an identifier.");
+ }
+
+ $response->fields->updateArgs(Auth_OpenID_OPENID_NS,
+ array('mode' => $mode,
+ 'return_to' => $this->return_to,
+ 'response_nonce' => Auth_OpenID_mkNonce()));
+
+ if (!$this->message->isOpenID1()) {
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'op_endpoint', $server_url);
+ }
+
+ if ($response_identity !== null) {
+ $response->fields->setArg(
+ Auth_OpenID_OPENID_NS,
+ 'identity',
+ $response_identity);
+ if ($this->message->isOpenID2()) {
+ $response->fields->setArg(
+ Auth_OpenID_OPENID_NS,
+ 'claimed_id',
+ $response_claimed_id);
+ }
+ }
+
+ } else {
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'mode', $mode);
+
+ if ($this->immediate) {
+ if (($this->message->isOpenID1()) &&
+ (!$server_url)) {
+ return new Auth_OpenID_ServerError(null,
+ 'setup_url is required for $allow=false \
+ in OpenID 1.x immediate mode.');
+ }
+
+ $setup_request = new Auth_OpenID_CheckIDRequest(
+ $this->identity,
+ $this->return_to,
+ $this->trust_root,
+ false,
+ $this->assoc_handle,
+ $this->server,
+ $this->claimed_id);
+ $setup_request->message = $this->message;
+
+ $setup_url = $setup_request->encodeToURL($server_url);
+
+ if ($setup_url === null) {
+ return new Auth_OpenID_NoReturnToError();
+ }
+
+ $response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'user_setup_url',
+ $setup_url);
+ }
+ }
+
+ return $response;
+ }
+
+ function encodeToURL($server_url)
+ {
+ if (!$this->return_to) {
+ return new Auth_OpenID_NoReturnToError();
+ }
+
+ // Imported from the alternate reality where these classes are
+ // used in both the client and server code, so Requests are
+ // Encodable too. That's right, code imported from alternate
+ // realities all for the love of you, id_res/user_setup_url.
+
+ $q = array('mode' => $this->mode,
+ 'identity' => $this->identity,
+ 'claimed_id' => $this->claimed_id,
+ 'return_to' => $this->return_to);
+
+ if ($this->trust_root) {
+ if ($this->message->isOpenID1()) {
+ $q['trust_root'] = $this->trust_root;
+ } else {
+ $q['realm'] = $this->trust_root;
+ }
+ }
+
+ if ($this->assoc_handle) {
+ $q['assoc_handle'] = $this->assoc_handle;
+ }
+
+ $response = new Auth_OpenID_Message(
+ $this->message->getOpenIDNamespace());
+ $response->updateArgs(Auth_OpenID_OPENID_NS, $q);
+ return $response->toURL($server_url);
+ }
+
+ function getCancelURL()
+ {
+ if (!$this->return_to) {
+ return new Auth_OpenID_NoReturnToError();
+ }
+
+ if ($this->immediate) {
+ return new Auth_OpenID_ServerError(null,
+ "Cancel is not an appropriate \
+ response to immediate mode \
+ requests.");
+ }
+
+ $response = new Auth_OpenID_Message(
+ $this->message->getOpenIDNamespace());
+ $response->setArg(Auth_OpenID_OPENID_NS, 'mode', 'cancel');
+ return $response->toURL($this->return_to);
+ }
+}
+
+/**
+ * This class encapsulates the response to an OpenID server request.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_ServerResponse {
+
+ function Auth_OpenID_ServerResponse($request)
+ {
+ $this->request = $request;
+ $this->fields = new Auth_OpenID_Message($this->request->namespace);
+ }
+
+ function whichEncoding()
+ {
+ global $_Auth_OpenID_Request_Modes;
+
+ if (in_array($this->request->mode, $_Auth_OpenID_Request_Modes)) {
+ if ($this->fields->isOpenID2() &&
+ (strlen($this->encodeToURL()) >
+ Auth_OpenID_OPENID1_URL_LIMIT)) {
+ return Auth_OpenID_ENCODE_HTML_FORM;
+ } else {
+ return Auth_OpenID_ENCODE_URL;
+ }
+ } else {
+ return Auth_OpenID_ENCODE_KVFORM;
+ }
+ }
+
+ /*
+ * Returns the form markup for this response.
+ *
+ * @return str
+ */
+ function toFormMarkup($form_tag_attrs=null)
+ {
+ return $this->fields->toFormMarkup($this->request->return_to,
+ $form_tag_attrs);
+ }
+
+ /*
+ * Returns an HTML document containing the form markup for this
+ * response that autosubmits with javascript.
+ */
+ function toHTML()
+ {
+ return Auth_OpenID::autoSubmitHTML($this->toFormMarkup());
+ }
+
+ /*
+ * Returns True if this response's encoding is ENCODE_HTML_FORM.
+ * Convenience method for server authors.
+ *
+ * @return bool
+ */
+ function renderAsForm()
+ {
+ return $this->whichEncoding() == Auth_OpenID_ENCODE_HTML_FORM;
+ }
+
+
+ function encodeToURL()
+ {
+ return $this->fields->toURL($this->request->return_to);
+ }
+
+ function addExtension($extension_response)
+ {
+ $extension_response->toMessage($this->fields);
+ }
+
+ function needsSigning()
+ {
+ return $this->fields->getArg(Auth_OpenID_OPENID_NS,
+ 'mode') == 'id_res';
+ }
+
+ function encodeToKVForm()
+ {
+ return $this->fields->toKVForm();
+ }
+}
+
+/**
+ * A web-capable response object which you can use to generate a
+ * user-agent response.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_WebResponse {
+ var $code = AUTH_OPENID_HTTP_OK;
+ var $body = "";
+
+ function Auth_OpenID_WebResponse($code = null, $headers = null,
+ $body = null)
+ {
+ if ($code) {
+ $this->code = $code;
+ }
+
+ if ($headers !== null) {
+ $this->headers = $headers;
+ } else {
+ $this->headers = array();
+ }
+
+ if ($body !== null) {
+ $this->body = $body;
+ }
+ }
+}
+
+/**
+ * Responsible for the signature of query data and the verification of
+ * OpenID signature values.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Signatory {
+
+ // = 14 * 24 * 60 * 60; # 14 days, in seconds
+ var $SECRET_LIFETIME = 1209600;
+
+ // keys have a bogus server URL in them because the filestore
+ // really does expect that key to be a URL. This seems a little
+ // silly for the server store, since I expect there to be only one
+ // server URL.
+ var $normal_key = 'http://localhost/|normal';
+ var $dumb_key = 'http://localhost/|dumb';
+
+ /**
+ * Create a new signatory using a given store.
+ */
+ function Auth_OpenID_Signatory($store)
+ {
+ // assert store is not None
+ $this->store = $store;
+ }
+
+ /**
+ * Verify, using a given association handle, a signature with
+ * signed key-value pairs from an HTTP request.
+ */
+ function verify($assoc_handle, $message)
+ {
+ $assoc = $this->getAssociation($assoc_handle, true);
+ if (!$assoc) {
+ // oidutil.log("failed to get assoc with handle %r to verify sig %r"
+ // % (assoc_handle, sig))
+ return false;
+ }
+
+ return $assoc->checkMessageSignature($message);
+ }
+
+ /**
+ * Given a response, sign the fields in the response's 'signed'
+ * list, and insert the signature into the response.
+ */
+ function sign($response)
+ {
+ $signed_response = $response;
+ $assoc_handle = $response->request->assoc_handle;
+
+ if ($assoc_handle) {
+ // normal mode
+ $assoc = $this->getAssociation($assoc_handle, false, false);
+ if (!$assoc || ($assoc->getExpiresIn() <= 0)) {
+ // fall back to dumb mode
+ $signed_response->fields->setArg(Auth_OpenID_OPENID_NS,
+ 'invalidate_handle', $assoc_handle);
+ $assoc_type = ($assoc ? $assoc->assoc_type : 'HMAC-SHA1');
+
+ if ($assoc && ($assoc->getExpiresIn() <= 0)) {
+ $this->invalidate($assoc_handle, false);
+ }
+
+ $assoc = $this->createAssociation(true, $assoc_type);
+ }
+ } else {
+ // dumb mode.
+ $assoc = $this->createAssociation(true);
+ }
+
+ $signed_response->fields = $assoc->signMessage(
+ $signed_response->fields);
+ return $signed_response;
+ }
+
+ /**
+ * Make a new association.
+ */
+ function createAssociation($dumb = true, $assoc_type = 'HMAC-SHA1')
+ {
+ $secret = Auth_OpenID_CryptUtil::getBytes(
+ Auth_OpenID_getSecretSize($assoc_type));
+
+ $uniq = base64_encode(Auth_OpenID_CryptUtil::getBytes(4));
+ $handle = sprintf('{%s}{%x}{%s}', $assoc_type, intval(time()), $uniq);
+
+ $assoc = Auth_OpenID_Association::fromExpiresIn(
+ $this->SECRET_LIFETIME, $handle, $secret, $assoc_type);
+
+ if ($dumb) {
+ $key = $this->dumb_key;
+ } else {
+ $key = $this->normal_key;
+ }
+
+ $this->store->storeAssociation($key, $assoc);
+ return $assoc;
+ }
+
+ /**
+ * Given an association handle, get the association from the
+ * store, or return a ServerError or null if something goes wrong.
+ */
+ function getAssociation($assoc_handle, $dumb, $check_expiration=true)
+ {
+ if ($assoc_handle === null) {
+ return new Auth_OpenID_ServerError(null,
+ "assoc_handle must not be null");
+ }
+
+ if ($dumb) {
+ $key = $this->dumb_key;
+ } else {
+ $key = $this->normal_key;
+ }
+
+ $assoc = $this->store->getAssociation($key, $assoc_handle);
+
+ if (($assoc !== null) && ($assoc->getExpiresIn() <= 0)) {
+ if ($check_expiration) {
+ $this->store->removeAssociation($key, $assoc_handle);
+ $assoc = null;
+ }
+ }
+
+ return $assoc;
+ }
+
+ /**
+ * Invalidate a given association handle.
+ */
+ function invalidate($assoc_handle, $dumb)
+ {
+ if ($dumb) {
+ $key = $this->dumb_key;
+ } else {
+ $key = $this->normal_key;
+ }
+ $this->store->removeAssociation($key, $assoc_handle);
+ }
+}
+
+/**
+ * Encode an {@link Auth_OpenID_ServerResponse} to an
+ * {@link Auth_OpenID_WebResponse}.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Encoder {
+
+ var $responseFactory = 'Auth_OpenID_WebResponse';
+
+ /**
+ * Encode an {@link Auth_OpenID_ServerResponse} and return an
+ * {@link Auth_OpenID_WebResponse}.
+ */
+ function encode($response)
+ {
+ $cls = $this->responseFactory;
+
+ $encode_as = $response->whichEncoding();
+ if ($encode_as == Auth_OpenID_ENCODE_KVFORM) {
+ $wr = new $cls(null, null, $response->encodeToKVForm());
+ if (is_a($response, 'Auth_OpenID_ServerError')) {
+ $wr->code = AUTH_OPENID_HTTP_ERROR;
+ }
+ } else if ($encode_as == Auth_OpenID_ENCODE_URL) {
+ $location = $response->encodeToURL();
+ $wr = new $cls(AUTH_OPENID_HTTP_REDIRECT,
+ array('location' => $location));
+ } else if ($encode_as == Auth_OpenID_ENCODE_HTML_FORM) {
+ $wr = new $cls(AUTH_OPENID_HTTP_OK, array(),
+ $response->toHTML());
+ } else {
+ return new Auth_OpenID_EncodingError($response);
+ }
+ /* Allow the response to carry a custom error code (ex: for Association errors) */
+ if(isset($response->code)) {
+ $wr->code = $response->code;
+ }
+ return $wr;
+ }
+}
+
+/**
+ * An encoder which also takes care of signing fields when required.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_SigningEncoder extends Auth_OpenID_Encoder {
+
+ function Auth_OpenID_SigningEncoder($signatory)
+ {
+ $this->signatory = $signatory;
+ }
+
+ /**
+ * Sign an {@link Auth_OpenID_ServerResponse} and return an
+ * {@link Auth_OpenID_WebResponse}.
+ */
+ function encode($response)
+ {
+ // the isinstance is a bit of a kludge... it means there isn't
+ // really an adapter to make the interfaces quite match.
+ if (!is_a($response, 'Auth_OpenID_ServerError') &&
+ $response->needsSigning()) {
+
+ if (!$this->signatory) {
+ return new Auth_OpenID_ServerError(null,
+ "Must have a store to sign request");
+ }
+
+ if ($response->fields->hasKey(Auth_OpenID_OPENID_NS, 'sig')) {
+ return new Auth_OpenID_AlreadySigned($response);
+ }
+ $response = $this->signatory->sign($response);
+ }
+
+ return parent::encode($response);
+ }
+}
+
+/**
+ * Decode an incoming query into an Auth_OpenID_Request.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Decoder {
+
+ function Auth_OpenID_Decoder($server)
+ {
+ $this->server = $server;
+
+ $this->handlers = array(
+ 'checkid_setup' => 'Auth_OpenID_CheckIDRequest',
+ 'checkid_immediate' => 'Auth_OpenID_CheckIDRequest',
+ 'check_authentication' => 'Auth_OpenID_CheckAuthRequest',
+ 'associate' => 'Auth_OpenID_AssociateRequest'
+ );
+ }
+
+ /**
+ * Given an HTTP query in an array (key-value pairs), decode it
+ * into an Auth_OpenID_Request object.
+ */
+ function decode($query)
+ {
+ if (!$query) {
+ return null;
+ }
+
+ $message = Auth_OpenID_Message::fromPostArgs($query);
+
+ if ($message === null) {
+ /*
+ * It's useful to have a Message attached to a
+ * ProtocolError, so we override the bad ns value to build
+ * a Message out of it. Kinda kludgy, since it's made of
+ * lies, but the parts that aren't lies are more useful
+ * than a 'None'.
+ */
+ $old_ns = $query['openid.ns'];
+
+ $query['openid.ns'] = Auth_OpenID_OPENID2_NS;
+ $message = Auth_OpenID_Message::fromPostArgs($query);
+ return new Auth_OpenID_ServerError(
+ $message,
+ sprintf("Invalid OpenID namespace URI: %s", $old_ns));
+ }
+
+ $mode = $message->getArg(Auth_OpenID_OPENID_NS, 'mode');
+ if (!$mode) {
+ return new Auth_OpenID_ServerError($message,
+ "No mode value in message");
+ }
+
+ if (Auth_OpenID::isFailure($mode)) {
+ return new Auth_OpenID_ServerError($message,
+ $mode->message);
+ }
+
+ $handlerCls = Auth_OpenID::arrayGet($this->handlers, $mode,
+ $this->defaultDecoder($message));
+
+ if (!is_a($handlerCls, 'Auth_OpenID_ServerError')) {
+ return call_user_func_array(array($handlerCls, 'fromMessage'),
+ array($message, $this->server));
+ } else {
+ return $handlerCls;
+ }
+ }
+
+ function defaultDecoder($message)
+ {
+ $mode = $message->getArg(Auth_OpenID_OPENID_NS, 'mode');
+
+ if (Auth_OpenID::isFailure($mode)) {
+ return new Auth_OpenID_ServerError($message,
+ $mode->message);
+ }
+
+ return new Auth_OpenID_ServerError($message,
+ sprintf("Unrecognized OpenID mode %s", $mode));
+ }
+}
+
+/**
+ * An error that indicates an encoding problem occurred.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_EncodingError {
+ function Auth_OpenID_EncodingError($response)
+ {
+ $this->response = $response;
+ }
+}
+
+/**
+ * An error that indicates that a response was already signed.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_AlreadySigned extends Auth_OpenID_EncodingError {
+ // This response is already signed.
+}
+
+/**
+ * An error that indicates that the given return_to is not under the
+ * given trust_root.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_UntrustedReturnURL extends Auth_OpenID_ServerError {
+ function Auth_OpenID_UntrustedReturnURL($message, $return_to,
+ $trust_root)
+ {
+ parent::Auth_OpenID_ServerError($message, "Untrusted return_to URL");
+ $this->return_to = $return_to;
+ $this->trust_root = $trust_root;
+ }
+
+ function toString()
+ {
+ return sprintf("return_to %s not under trust_root %s",
+ $this->return_to, $this->trust_root);
+ }
+}
+
+/**
+ * I handle requests for an OpenID server.
+ *
+ * Some types of requests (those which are not checkid requests) may
+ * be handed to my {@link handleRequest} method, and I will take care
+ * of it and return a response.
+ *
+ * For your convenience, I also provide an interface to {@link
+ * Auth_OpenID_Decoder::decode()} and {@link
+ * Auth_OpenID_SigningEncoder::encode()} through my methods {@link
+ * decodeRequest} and {@link encodeResponse}.
+ *
+ * All my state is encapsulated in an {@link Auth_OpenID_OpenIDStore}.
+ *
+ * Example:
+ *
+ * <pre> $oserver = new Auth_OpenID_Server(Auth_OpenID_FileStore($data_path),
+ * "http://example.com/op");
+ * $request = $oserver->decodeRequest();
+ * if (in_array($request->mode, array('checkid_immediate',
+ * 'checkid_setup'))) {
+ * if ($app->isAuthorized($request->identity, $request->trust_root)) {
+ * $response = $request->answer(true);
+ * } else if ($request->immediate) {
+ * $response = $request->answer(false);
+ * } else {
+ * $app->showDecidePage($request);
+ * return;
+ * }
+ * } else {
+ * $response = $oserver->handleRequest($request);
+ * }
+ *
+ * $webresponse = $oserver->encode($response);</pre>
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_Server {
+ function Auth_OpenID_Server($store, $op_endpoint=null)
+ {
+ $this->store = $store;
+ $this->signatory = new Auth_OpenID_Signatory($this->store);
+ $this->encoder = new Auth_OpenID_SigningEncoder($this->signatory);
+ $this->decoder = new Auth_OpenID_Decoder($this);
+ $this->op_endpoint = $op_endpoint;
+ $this->negotiator = Auth_OpenID_getDefaultNegotiator();
+ }
+
+ /**
+ * Handle a request. Given an {@link Auth_OpenID_Request} object,
+ * call the appropriate {@link Auth_OpenID_Server} method to
+ * process the request and generate a response.
+ *
+ * @param Auth_OpenID_Request $request An {@link Auth_OpenID_Request}
+ * returned by {@link Auth_OpenID_Server::decodeRequest()}.
+ *
+ * @return Auth_OpenID_ServerResponse $response A response object
+ * capable of generating a user-agent reply.
+ */
+ function handleRequest($request)
+ {
+ if (method_exists($this, "openid_" . $request->mode)) {
+ $handler = array($this, "openid_" . $request->mode);
+ return call_user_func($handler, &$request);
+ }
+ return null;
+ }
+
+ /**
+ * The callback for 'check_authentication' messages.
+ */
+ function openid_check_authentication($request)
+ {
+ return $request->answer($this->signatory);
+ }
+
+ /**
+ * The callback for 'associate' messages.
+ */
+ function openid_associate($request)
+ {
+ $assoc_type = $request->assoc_type;
+ $session_type = $request->session->session_type;
+ if ($this->negotiator->isAllowed($assoc_type, $session_type)) {
+ $assoc = $this->signatory->createAssociation(false,
+ $assoc_type);
+ return $request->answer($assoc);
+ } else {
+ $message = sprintf('Association type %s is not supported with '.
+ 'session type %s', $assoc_type, $session_type);
+ list($preferred_assoc_type, $preferred_session_type) =
+ $this->negotiator->getAllowedType();
+ return $request->answerUnsupported($message,
+ $preferred_assoc_type,
+ $preferred_session_type);
+ }
+ }
+
+ /**
+ * Encodes as response in the appropriate format suitable for
+ * sending to the user agent.
+ */
+ function encodeResponse($response)
+ {
+ return $this->encoder->encode($response);
+ }
+
+ /**
+ * Decodes a query args array into the appropriate
+ * {@link Auth_OpenID_Request} object.
+ */
+ function decodeRequest($query=null)
+ {
+ if ($query === null) {
+ $query = Auth_OpenID::getQuery();
+ }
+
+ return $this->decoder->decode($query);
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/ServerRequest.php
@@ -1,1 +1,37 @@
+<?php
+/**
+ * OpenID Server Request
+ *
+ * @see Auth_OpenID_Server
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+/**
+ * Imports
+ */
+require_once "Auth/OpenID.php";
+
+/**
+ * Object that holds the state of a request to the OpenID server
+ *
+ * With accessor functions to get at the internal request data.
+ *
+ * @see Auth_OpenID_Server
+ * @package OpenID
+ */
+class Auth_OpenID_ServerRequest {
+ function Auth_OpenID_ServerRequest()
+ {
+ $this->mode = null;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/TrustRoot.php
@@ -1,1 +1,462 @@
-
+<?php
+/**
+ * Functions for dealing with OpenID trust roots
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+require_once 'Auth/OpenID/Discover.php';
+
+/**
+ * A regular expression that matches a domain ending in a top-level domains.
+ * Used in checking trust roots for sanity.
+ *
+ * @access private
+ */
+define('Auth_OpenID___TLDs',
+ '/\.(ac|ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|asia' .
+ '|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br' .
+ '|bs|bt|bv|bw|by|bz|ca|cat|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co' .
+ '|com|coop|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg' .
+ '|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl' .
+ '|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie' .
+ '|il|im|in|info|int|io|iq|ir|is|it|je|jm|jo|jobs|jp|ke|kg|kh' .
+ '|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly' .
+ '|ma|mc|md|me|mg|mh|mil|mk|ml|mm|mn|mo|mobi|mp|mq|mr|ms|mt' .
+ '|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no' .
+ '|np|nr|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt' .
+ '|pw|py|qa|re|ro|rs|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl' .
+ '|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tel|tf|tg|th|tj|tk|tl|tm' .
+ '|tn|to|tp|tr|travel|tt|tv|tw|tz|ua|ug|uk|us|uy|uz|va|vc|ve' .
+ '|vg|vi|vn|vu|wf|ws|xn--0zwm56d|xn--11b5bs3a9aj6g' .
+ '|xn--80akhbyknj4f|xn--9t4b11yi5a|xn--deba0ad|xn--g6w251d' .
+ '|xn--hgbk6aj7f53bba|xn--hlcj6aya9esc7a|xn--jxalpdlp' .
+ '|xn--kgbechtv|xn--zckzah|ye|yt|yu|za|zm|zw)\.?$/');
+
+define('Auth_OpenID___HostSegmentRe',
+ "/^(?:[-a-zA-Z0-9!$&'\\(\\)\\*+,;=._~]|%[a-zA-Z0-9]{2})*$/");
+
+/**
+ * A wrapper for trust-root related functions
+ */
+class Auth_OpenID_TrustRoot {
+ /*
+ * Return a discovery URL for this realm.
+ *
+ * Return null if the realm could not be parsed or was not valid.
+ *
+ * @param return_to The relying party return URL of the OpenID
+ * authentication request
+ *
+ * @return The URL upon which relying party discovery should be
+ * run in order to verify the return_to URL
+ */
+ static function buildDiscoveryURL($realm)
+ {
+ $parsed = Auth_OpenID_TrustRoot::_parse($realm);
+
+ if ($parsed === false) {
+ return false;
+ }
+
+ if ($parsed['wildcard']) {
+ // Use "www." in place of the star
+ if ($parsed['host'][0] != '.') {
+ return false;
+ }
+
+ $www_domain = 'www' . $parsed['host'];
+
+ return sprintf('%s://%s%s', $parsed['scheme'],
+ $www_domain, $parsed['path']);
+ } else {
+ return $parsed['unparsed'];
+ }
+ }
+
+ /**
+ * Parse a URL into its trust_root parts.
+ *
+ * @static
+ *
+ * @access private
+ *
+ * @param string $trust_root The url to parse
+ *
+ * @return mixed $parsed Either an associative array of trust root
+ * parts or false if parsing failed.
+ */
+ static function _parse($trust_root)
+ {
+ $trust_root = Auth_OpenID_urinorm($trust_root);
+ if ($trust_root === null) {
+ return false;
+ }
+
+ if (preg_match("/:\/\/[^:]+(:\d+){2,}(\/|$)/", $trust_root)) {
+ return false;
+ }
+
+ $parts = @parse_url($trust_root);
+ if ($parts === false) {
+ return false;
+ }
+
+ $required_parts = array('scheme', 'host');
+ $forbidden_parts = array('user', 'pass', 'fragment');
+ $keys = array_keys($parts);
+ if (array_intersect($keys, $required_parts) != $required_parts) {
+ return false;
+ }
+
+ if (array_intersect($keys, $forbidden_parts) != array()) {
+ return false;
+ }
+
+ if (!preg_match(Auth_OpenID___HostSegmentRe, $parts['host'])) {
+ return false;
+ }
+
+ $scheme = strtolower($parts['scheme']);
+ $allowed_schemes = array('http', 'https');
+ if (!in_array($scheme, $allowed_schemes)) {
+ return false;
+ }
+ $parts['scheme'] = $scheme;
+
+ $host = strtolower($parts['host']);
+ $hostparts = explode('*', $host);
+ switch (count($hostparts)) {
+ case 1:
+ $parts['wildcard'] = false;
+ break;
+ case 2:
+ if ($hostparts[0] ||
+ ($hostparts[1] && substr($hostparts[1], 0, 1) != '.')) {
+ return false;
+ }
+ $host = $hostparts[1];
+ $parts['wildcard'] = true;
+ break;
+ default:
+ return false;
+ }
+ if (strpos($host, ':') !== false) {
+ return false;
+ }
+
+ $parts['host'] = $host;
+
+ if (isset($parts['path'])) {
+ $path = strtolower($parts['path']);
+ if (substr($path, 0, 1) != '/') {
+ return false;
+ }
+ } else {
+ $path = '/';
+ }
+
+ $parts['path'] = $path;
+ if (!isset($parts['port'])) {
+ $parts['port'] = false;
+ }
+
+
+ $parts['unparsed'] = $trust_root;
+
+ return $parts;
+ }
+
+ /**
+ * Is this trust root sane?
+ *
+ * A trust root is sane if it is syntactically valid and it has a
+ * reasonable domain name. Specifically, the domain name must be
+ * more than one level below a standard TLD or more than two
+ * levels below a two-letter tld.
+ *
+ * For example, '*.com' is not a sane trust root, but '*.foo.com'
+ * is. '*.co.uk' is not sane, but '*.bbc.co.uk' is.
+ *
+ * This check is not always correct, but it attempts to err on the
+ * side of marking sane trust roots insane instead of marking
+ * insane trust roots sane. For example, 'kink.fm' is marked as
+ * insane even though it "should" (for some meaning of should) be
+ * marked sane.
+ *
+ * This function should be used when creating OpenID servers to
+ * alert the users of the server when a consumer attempts to get
+ * the user to accept a suspicious trust root.
+ *
+ * @static
+ * @param string $trust_root The trust root to check
+ * @return bool $sanity Whether the trust root looks OK
+ */
+ static function isSane($trust_root)
+ {
+ $parts = Auth_OpenID_TrustRoot::_parse($trust_root);
+ if ($parts === false) {
+ return false;
+ }
+
+ // Localhost is a special case
+ if ($parts['host'] == 'localhost') {
+ return true;
+ }
+
+ $host_parts = explode('.', $parts['host']);
+ if ($parts['wildcard']) {
+ // Remove the empty string from the beginning of the array
+ array_shift($host_parts);
+ }
+
+ if ($host_parts && !$host_parts[count($host_parts) - 1]) {
+ array_pop($host_parts);
+ }
+
+ if (!$host_parts) {
+ return false;
+ }
+
+ // Don't allow adjacent dots
+ if (in_array('', $host_parts, true)) {
+ return false;
+ }
+
+ // Get the top-level domain of the host. If it is not a valid TLD,
+ // it's not sane.
+ preg_match(Auth_OpenID___TLDs, $parts['host'], $matches);
+ if (!$matches) {
+ return false;
+ }
+ $tld = $matches[1];
+
+ if (count($host_parts) == 1) {
+ return false;
+ }
+
+ if ($parts['wildcard']) {
+ // It's a 2-letter tld with a short second to last segment
+ // so there needs to be more than two segments specified
+ // (e.g. *.co.uk is insane)
+ $second_level = $host_parts[count($host_parts) - 2];
+ if (strlen($tld) == 2 && strlen($second_level) <= 3) {
+ return count($host_parts) > 2;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Does this URL match the given trust root?
+ *
+ * Return whether the URL falls under the given trust root. This
+ * does not check whether the trust root is sane. If the URL or
+ * trust root do not parse, this function will return false.
+ *
+ * @param string $trust_root The trust root to match against
+ *
+ * @param string $url The URL to check
+ *
+ * @return bool $matches Whether the URL matches against the
+ * trust root
+ */
+ static function match($trust_root, $url)
+ {
+ $trust_root_parsed = Auth_OpenID_TrustRoot::_parse($trust_root);
+ $url_parsed = Auth_OpenID_TrustRoot::_parse($url);
+ if (!$trust_root_parsed || !$url_parsed) {
+ return false;
+ }
+
+ // Check hosts matching
+ if ($url_parsed['wildcard']) {
+ return false;
+ }
+ if ($trust_root_parsed['wildcard']) {
+ $host_tail = $trust_root_parsed['host'];
+ $host = $url_parsed['host'];
+ if ($host_tail &&
+ substr($host, -(strlen($host_tail))) != $host_tail &&
+ substr($host_tail, 1) != $host) {
+ return false;
+ }
+ } else {
+ if ($trust_root_parsed['host'] != $url_parsed['host']) {
+ return false;
+ }
+ }
+
+ // Check path and query matching
+ $base_path = $trust_root_parsed['path'];
+ $path = $url_parsed['path'];
+ if (!isset($trust_root_parsed['query'])) {
+ if ($base_path != $path) {
+ if (substr($path, 0, strlen($base_path)) != $base_path) {
+ return false;
+ }
+ if (substr($base_path, strlen($base_path) - 1, 1) != '/' &&
+ substr($path, strlen($base_path), 1) != '/') {
+ return false;
+ }
+ }
+ } else {
+ $base_query = $trust_root_parsed['query'];
+ $query = @$url_parsed['query'];
+ $qplus = substr($query, 0, strlen($base_query) + 1);
+ $bqplus = $base_query . '&';
+ if ($base_path != $path ||
+ ($base_query != $query && $qplus != $bqplus)) {
+ return false;
+ }
+ }
+
+ // The port and scheme need to match exactly
+ return ($trust_root_parsed['scheme'] == $url_parsed['scheme'] &&
+ $url_parsed['port'] === $trust_root_parsed['port']);
+ }
+}
+
+/*
+ * If the endpoint is a relying party OpenID return_to endpoint,
+ * return the endpoint URL. Otherwise, return None.
+ *
+ * This function is intended to be used as a filter for the Yadis
+ * filtering interface.
+ *
+ * @see: C{L{openid.yadis.services}}
+ * @see: C{L{openid.yadis.filters}}
+ *
+ * @param endpoint: An XRDS BasicServiceEndpoint, as returned by
+ * performing Yadis dicovery.
+ *
+ * @returns: The endpoint URL or None if the endpoint is not a
+ * relying party endpoint.
+ */
+function filter_extractReturnURL($endpoint)
+{
+ if ($endpoint->matchTypes(array(Auth_OpenID_RP_RETURN_TO_URL_TYPE))) {
+ return $endpoint;
+ } else {
+ return null;
+ }
+}
+
+function &Auth_OpenID_extractReturnURL(&$endpoint_list)
+{
+ $result = array();
+
+ foreach ($endpoint_list as $endpoint) {
+ if (filter_extractReturnURL($endpoint)) {
+ $result[] = $endpoint;
+ }
+ }
+
+ return $result;
+}
+
+/*
+ * Is the return_to URL under one of the supplied allowed return_to
+ * URLs?
+ */
+function Auth_OpenID_returnToMatches($allowed_return_to_urls, $return_to)
+{
+ foreach ($allowed_return_to_urls as $allowed_return_to) {
+ // A return_to pattern works the same as a realm, except that
+ // it's not allowed to use a wildcard. We'll model this by
+ // parsing it as a realm, and not trying to match it if it has
+ // a wildcard.
+
+ $return_realm = Auth_OpenID_TrustRoot::_parse($allowed_return_to);
+ if (// Parses as a trust root
+ ($return_realm !== false) &&
+ // Does not have a wildcard
+ (!$return_realm['wildcard']) &&
+ // Matches the return_to that we passed in with it
+ (Auth_OpenID_TrustRoot::match($allowed_return_to, $return_to))) {
+ return true;
+ }
+ }
+
+ // No URL in the list matched
+ return false;
+}
+
+/*
+ * Given a relying party discovery URL return a list of return_to
+ * URLs.
+ */
+function Auth_OpenID_getAllowedReturnURLs($relying_party_url, $fetcher,
+ $discover_function=null)
+{
+ if ($discover_function === null) {
+ $discover_function = array('Auth_Yadis_Yadis', 'discover');
+ }
+
+ $xrds_parse_cb = array('Auth_OpenID_ServiceEndpoint', 'consumerFromXRDS');
+
+ list($rp_url_after_redirects, $endpoints) =
+ Auth_Yadis_getServiceEndpoints($relying_party_url, $xrds_parse_cb,
+ $discover_function, $fetcher);
+
+ if ($rp_url_after_redirects != $relying_party_url) {
+ // Verification caused a redirect
+ return false;
+ }
+
+ call_user_func_array($discover_function,
+ array($relying_party_url, &$fetcher));
+
+ $return_to_urls = array();
+ $matching_endpoints = Auth_OpenID_extractReturnURL($endpoints);
+
+ foreach ($matching_endpoints as $e) {
+ $return_to_urls[] = $e->server_url;
+ }
+
+ return $return_to_urls;
+}
+
+/*
+ * Verify that a return_to URL is valid for the given realm.
+ *
+ * This function builds a discovery URL, performs Yadis discovery on
+ * it, makes sure that the URL does not redirect, parses out the
+ * return_to URLs, and finally checks to see if the current return_to
+ * URL matches the return_to.
+ *
+ * @return true if the return_to URL is valid for the realm
+ */
+function Auth_OpenID_verifyReturnTo($realm_str, $return_to, $fetcher,
+ $_vrfy='Auth_OpenID_getAllowedReturnURLs')
+{
+ $disco_url = Auth_OpenID_TrustRoot::buildDiscoveryURL($realm_str);
+
+ if ($disco_url === false) {
+ return false;
+ }
+
+ $allowable_urls = call_user_func_array($_vrfy,
+ array($disco_url, $fetcher));
+
+ // The realm_str could not be parsed.
+ if ($allowable_urls === false) {
+ return false;
+ }
+
+ if (Auth_OpenID_returnToMatches($allowable_urls, $return_to)) {
+ return true;
+ } else {
+ return false;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/OpenID/URINorm.php
@@ -1,1 +1,250 @@
-
+<?php
+
+/**
+ * URI normalization routines.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+require_once 'Auth/Yadis/Misc.php';
+
+// from appendix B of rfc 3986 (http://www.ietf.org/rfc/rfc3986.txt)
+function Auth_OpenID_getURIPattern()
+{
+ return '&^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?&';
+}
+
+function Auth_OpenID_getAuthorityPattern()
+{
+ return '/^([^@]*@)?([^:]*)(:.*)?/';
+}
+
+function Auth_OpenID_getEncodedPattern()
+{
+ return '/%([0-9A-Fa-f]{2})/';
+}
+
+# gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
+#
+# sub-delims = "!" / "$" / "&" / "'" / "(" / ")"
+# / "*" / "+" / "," / ";" / "="
+#
+# unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
+function Auth_OpenID_getURLIllegalCharRE()
+{
+ return "/([^-A-Za-z0-9:\/\?#\[\]@\!\$&'\(\)\*\+,;=\._~\%])/";
+}
+
+function Auth_OpenID_getUnreserved()
+{
+ $_unreserved = array();
+ for ($i = 0; $i < 256; $i++) {
+ $_unreserved[$i] = false;
+ }
+
+ for ($i = ord('A'); $i <= ord('Z'); $i++) {
+ $_unreserved[$i] = true;
+ }
+
+ for ($i = ord('0'); $i <= ord('9'); $i++) {
+ $_unreserved[$i] = true;
+ }
+
+ for ($i = ord('a'); $i <= ord('z'); $i++) {
+ $_unreserved[$i] = true;
+ }
+
+ $_unreserved[ord('-')] = true;
+ $_unreserved[ord('.')] = true;
+ $_unreserved[ord('_')] = true;
+ $_unreserved[ord('~')] = true;
+
+ return $_unreserved;
+}
+
+function Auth_OpenID_getEscapeRE()
+{
+ $parts = array();
+ foreach (array_merge(Auth_Yadis_getUCSChars(),
+ Auth_Yadis_getIPrivateChars()) as $pair) {
+ list($m, $n) = $pair;
+ $parts[] = sprintf("%s-%s", chr($m), chr($n));
+ }
+
+ return sprintf('[%s]', implode('', $parts));
+}
+
+function Auth_OpenID_pct_encoded_replace_unreserved($mo)
+{
+ $_unreserved = Auth_OpenID_getUnreserved();
+
+ $i = intval($mo[1], 16);
+ if ($_unreserved[$i]) {
+ return chr($i);
+ } else {
+ return strtoupper($mo[0]);
+ }
+
+ return $mo[0];
+}
+
+function Auth_OpenID_pct_encoded_replace($mo)
+{
+ return chr(intval($mo[1], 16));
+}
+
+function Auth_OpenID_remove_dot_segments($path)
+{
+ $result_segments = array();
+
+ while ($path) {
+ if (Auth_Yadis_startswith($path, '../')) {
+ $path = substr($path, 3);
+ } else if (Auth_Yadis_startswith($path, './')) {
+ $path = substr($path, 2);
+ } else if (Auth_Yadis_startswith($path, '/./')) {
+ $path = substr($path, 2);
+ } else if ($path == '/.') {
+ $path = '/';
+ } else if (Auth_Yadis_startswith($path, '/../')) {
+ $path = substr($path, 3);
+ if ($result_segments) {
+ array_pop($result_segments);
+ }
+ } else if ($path == '/..') {
+ $path = '/';
+ if ($result_segments) {
+ array_pop($result_segments);
+ }
+ } else if (($path == '..') ||
+ ($path == '.')) {
+ $path = '';
+ } else {
+ $i = 0;
+ if ($path[0] == '/') {
+ $i = 1;
+ }
+ $i = strpos($path, '/', $i);
+ if ($i === false) {
+ $i = strlen($path);
+ }
+ $result_segments[] = substr($path, 0, $i);
+ $path = substr($path, $i);
+ }
+ }
+
+ return implode('', $result_segments);
+}
+
+function Auth_OpenID_urinorm($uri)
+{
+ $uri_matches = array();
+ preg_match(Auth_OpenID_getURIPattern(), $uri, $uri_matches);
+
+ if (count($uri_matches) < 9) {
+ for ($i = count($uri_matches); $i <= 9; $i++) {
+ $uri_matches[] = '';
+ }
+ }
+
+ $illegal_matches = array();
+ preg_match(Auth_OpenID_getURLIllegalCharRE(),
+ $uri, $illegal_matches);
+ if ($illegal_matches) {
+ return null;
+ }
+
+ $scheme = $uri_matches[2];
+ if ($scheme) {
+ $scheme = strtolower($scheme);
+ }
+
+ $scheme = $uri_matches[2];
+ if ($scheme === '') {
+ // No scheme specified
+ return null;
+ }
+
+ $scheme = strtolower($scheme);
+ if (!in_array($scheme, array('http', 'https'))) {
+ // Not an absolute HTTP or HTTPS URI
+ return null;
+ }
+
+ $authority = $uri_matches[4];
+ if ($authority === '') {
+ // Not an absolute URI
+ return null;
+ }
+
+ $authority_matches = array();
+ preg_match(Auth_OpenID_getAuthorityPattern(),
+ $authority, $authority_matches);
+ if (count($authority_matches) === 0) {
+ // URI does not have a valid authority
+ return null;
+ }
+
+ if (count($authority_matches) < 4) {
+ for ($i = count($authority_matches); $i <= 4; $i++) {
+ $authority_matches[] = '';
+ }
+ }
+
+ list($_whole, $userinfo, $host, $port) = $authority_matches;
+
+ if ($userinfo === null) {
+ $userinfo = '';
+ }
+
+ if (strpos($host, '%') !== -1) {
+ $host = strtolower($host);
+ $host = preg_replace_callback(
+ Auth_OpenID_getEncodedPattern(),
+ 'Auth_OpenID_pct_encoded_replace', $host);
+ // NO IDNA.
+ // $host = unicode($host, 'utf-8').encode('idna');
+ } else {
+ $host = strtolower($host);
+ }
+
+ if ($port) {
+ if (($port == ':') ||
+ ($scheme == 'http' && $port == ':80') ||
+ ($scheme == 'https' && $port == ':443')) {
+ $port = '';
+ }
+ } else {
+ $port = '';
+ }
+
+ $authority = $userinfo . $host . $port;
+
+ $path = $uri_matches[5];
+ $path = preg_replace_callback(
+ Auth_OpenID_getEncodedPattern(),
+ 'Auth_OpenID_pct_encoded_replace_unreserved', $path);
+
+ $path = Auth_OpenID_remove_dot_segments($path);
+ if (!$path) {
+ $path = '/';
+ }
+
+ $query = $uri_matches[6];
+ if ($query === null) {
+ $query = '';
+ }
+
+ $fragment = $uri_matches[8];
+ if ($fragment === null) {
+ $fragment = '';
+ }
+
+ return $scheme . '://' . $authority . $path . $query . $fragment;
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/HTTPFetcher.php
@@ -1,1 +1,175 @@
+<?php
+/**
+ * This module contains the HTTP fetcher interface
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Require logging functionality
+ */
+require_once "Auth/OpenID.php";
+
+define('Auth_OpenID_FETCHER_MAX_RESPONSE_KB', 1024);
+define('Auth_OpenID_USER_AGENT',
+ 'php-openid/'.Auth_OpenID_VERSION.' (php/'.phpversion().')');
+
+class Auth_Yadis_HTTPResponse {
+ function Auth_Yadis_HTTPResponse($final_url = null, $status = null,
+ $headers = null, $body = null)
+ {
+ $this->final_url = $final_url;
+ $this->status = $status;
+ $this->headers = $headers;
+ $this->body = $body;
+ }
+}
+
+/**
+ * This class is the interface for HTTP fetchers the Yadis library
+ * uses. This interface is only important if you need to write a new
+ * fetcher for some reason.
+ *
+ * @access private
+ * @package OpenID
+ */
+class Auth_Yadis_HTTPFetcher {
+
+ var $timeout = 20; // timeout in seconds.
+
+ /**
+ * Return whether a URL can be fetched. Returns false if the URL
+ * scheme is not allowed or is not supported by this fetcher
+ * implementation; returns true otherwise.
+ *
+ * @return bool
+ */
+ function canFetchURL($url)
+ {
+ if ($this->isHTTPS($url) && !$this->supportsSSL()) {
+ Auth_OpenID::log("HTTPS URL unsupported fetching %s",
+ $url);
+ return false;
+ }
+
+ if (!$this->allowedURL($url)) {
+ Auth_OpenID::log("URL fetching not allowed for '%s'",
+ $url);
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Return whether a URL should be allowed. Override this method to
+ * conform to your local policy.
+ *
+ * By default, will attempt to fetch any http or https URL.
+ */
+ function allowedURL($url)
+ {
+ return $this->URLHasAllowedScheme($url);
+ }
+
+ /**
+ * Does this fetcher implementation (and runtime) support fetching
+ * HTTPS URLs? May inspect the runtime environment.
+ *
+ * @return bool $support True if this fetcher supports HTTPS
+ * fetching; false if not.
+ */
+ function supportsSSL()
+ {
+ trigger_error("not implemented", E_USER_ERROR);
+ }
+
+ /**
+ * Is this an https URL?
+ *
+ * @access private
+ */
+ function isHTTPS($url)
+ {
+ return (bool)preg_match('/^https:\/\//i', $url);
+ }
+
+ /**
+ * Is this an http or https URL?
+ *
+ * @access private
+ */
+ function URLHasAllowedScheme($url)
+ {
+ return (bool)preg_match('/^https?:\/\//i', $url);
+ }
+
+ /**
+ * @access private
+ */
+ function _findRedirect($headers, $url)
+ {
+ foreach ($headers as $line) {
+ if (strpos(strtolower($line), "location: ") === 0) {
+ $parts = explode(" ", $line, 2);
+ $loc = $parts[1];
+ $ppos = strpos($loc, "://");
+ if ($ppos === false || $ppos > strpos($loc, "/")) {
+ /* no host; add it */
+ $hpos = strpos($url, "://");
+ $prt = substr($url, 0, $hpos+3);
+ $url = substr($url, $hpos+3);
+ if (substr($loc, 0, 1) == "/") {
+ /* absolute path */
+ $fspos = strpos($url, "/");
+ if ($fspos) $loc = $prt.substr($url, 0, $fspos).$loc;
+ else $loc = $prt.$url.$loc;
+ } else {
+ /* relative path */
+ $pp = $prt;
+ while (1) {
+ $xpos = strpos($url, "/");
+ if ($xpos === false) break;
+ $apos = strpos($url, "?");
+ if ($apos !== false && $apos < $xpos) break;
+ $apos = strpos($url, "&");
+ if ($apos !== false && $apos < $xpos) break;
+ $pp .= substr($url, 0, $xpos+1);
+ $url = substr($url, $xpos+1);
+ }
+ $loc = $pp.$loc;
+ }
+ }
+ return $loc;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Fetches the specified URL using optional extra headers and
+ * returns the server's response.
+ *
+ * @param string $url The URL to be fetched.
+ * @param array $extra_headers An array of header strings
+ * (e.g. "Accept: text/html").
+ * @return mixed $result An array of ($code, $url, $headers,
+ * $body) if the URL could be fetched; null if the URL does not
+ * pass the URLHasAllowedScheme check or if the server's response
+ * is malformed.
+ */
+ function get($url, $headers = null)
+ {
+ trigger_error("not implemented", E_USER_ERROR);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/Manager.php
@@ -1,1 +1,522 @@
-
+<?php
+
+/**
+ * Yadis service manager to be used during yadis-driven authentication
+ * attempts.
+ *
+ * @package OpenID
+ */
+
+/**
+ * The base session class used by the Auth_Yadis_Manager. This
+ * class wraps the default PHP session machinery and should be
+ * subclassed if your application doesn't use PHP sessioning.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_PHPSession {
+ /**
+ * Set a session key/value pair.
+ *
+ * @param string $name The name of the session key to add.
+ * @param string $value The value to add to the session.
+ */
+ function set($name, $value)
+ {
+ $_SESSION[$name] = $value;
+ }
+
+ /**
+ * Get a key's value from the session.
+ *
+ * @param string $name The name of the key to retrieve.
+ * @param string $default The optional value to return if the key
+ * is not found in the session.
+ * @return string $result The key's value in the session or
+ * $default if it isn't found.
+ */
+ function get($name, $default=null)
+ {
+ if (array_key_exists($name, $_SESSION)) {
+ return $_SESSION[$name];
+ } else {
+ return $default;
+ }
+ }
+
+ /**
+ * Remove a key/value pair from the session.
+ *
+ * @param string $name The name of the key to remove.
+ */
+ function del($name)
+ {
+ unset($_SESSION[$name]);
+ }
+
+ /**
+ * Return the contents of the session in array form.
+ */
+ function contents()
+ {
+ return $_SESSION;
+ }
+}
+
+/**
+ * A session helper class designed to translate between arrays and
+ * objects. Note that the class used must have a constructor that
+ * takes no parameters. This is not a general solution, but it works
+ * for dumb objects that just need to have attributes set. The idea
+ * is that you'll subclass this and override $this->check($data) ->
+ * bool to implement your own session data validation.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_SessionLoader {
+ /**
+ * Override this.
+ *
+ * @access private
+ */
+ function check($data)
+ {
+ return true;
+ }
+
+ /**
+ * Given a session data value (an array), this creates an object
+ * (returned by $this->newObject()) whose attributes and values
+ * are those in $data. Returns null if $data lacks keys found in
+ * $this->requiredKeys(). Returns null if $this->check($data)
+ * evaluates to false. Returns null if $this->newObject()
+ * evaluates to false.
+ *
+ * @access private
+ */
+ function fromSession($data)
+ {
+ if (!$data) {
+ return null;
+ }
+
+ $required = $this->requiredKeys();
+
+ foreach ($required as $k) {
+ if (!array_key_exists($k, $data)) {
+ return null;
+ }
+ }
+
+ if (!$this->check($data)) {
+ return null;
+ }
+
+ $data = array_merge($data, $this->prepareForLoad($data));
+ $obj = $this->newObject($data);
+
+ if (!$obj) {
+ return null;
+ }
+
+ foreach ($required as $k) {
+ $obj->$k = $data[$k];
+ }
+
+ return $obj;
+ }
+
+ /**
+ * Prepares the data array by making any necessary changes.
+ * Returns an array whose keys and values will be used to update
+ * the original data array before calling $this->newObject($data).
+ *
+ * @access private
+ */
+ function prepareForLoad($data)
+ {
+ return array();
+ }
+
+ /**
+ * Returns a new instance of this loader's class, using the
+ * session data to construct it if necessary. The object need
+ * only be created; $this->fromSession() will take care of setting
+ * the object's attributes.
+ *
+ * @access private
+ */
+ function newObject($data)
+ {
+ return null;
+ }
+
+ /**
+ * Returns an array of keys and values built from the attributes
+ * of $obj. If $this->prepareForSave($obj) returns an array, its keys
+ * and values are used to update the $data array of attributes
+ * from $obj.
+ *
+ * @access private
+ */
+ function toSession($obj)
+ {
+ $data = array();
+ foreach ($obj as $k => $v) {
+ $data[$k] = $v;
+ }
+
+ $extra = $this->prepareForSave($obj);
+
+ if ($extra && is_array($extra)) {
+ foreach ($extra as $k => $v) {
+ $data[$k] = $v;
+ }
+ }
+
+ return $data;
+ }
+
+ /**
+ * Override this.
+ *
+ * @access private
+ */
+ function prepareForSave($obj)
+ {
+ return array();
+ }
+}
+
+/**
+ * A concrete loader implementation for Auth_OpenID_ServiceEndpoints.
+ *
+ * @package OpenID
+ */
+class Auth_OpenID_ServiceEndpointLoader extends Auth_Yadis_SessionLoader {
+ function newObject($data)
+ {
+ return new Auth_OpenID_ServiceEndpoint();
+ }
+
+ function requiredKeys()
+ {
+ $obj = new Auth_OpenID_ServiceEndpoint();
+ $data = array();
+ foreach ($obj as $k => $v) {
+ $data[] = $k;
+ }
+ return $data;
+ }
+
+ function check($data)
+ {
+ return is_array($data['type_uris']);
+ }
+}
+
+/**
+ * A concrete loader implementation for Auth_Yadis_Managers.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_ManagerLoader extends Auth_Yadis_SessionLoader {
+ function requiredKeys()
+ {
+ return array('starting_url',
+ 'yadis_url',
+ 'services',
+ 'session_key',
+ '_current',
+ 'stale');
+ }
+
+ function newObject($data)
+ {
+ return new Auth_Yadis_Manager($data['starting_url'],
+ $data['yadis_url'],
+ $data['services'],
+ $data['session_key']);
+ }
+
+ function check($data)
+ {
+ return is_array($data['services']);
+ }
+
+ function prepareForLoad($data)
+ {
+ $loader = new Auth_OpenID_ServiceEndpointLoader();
+ $services = array();
+ foreach ($data['services'] as $s) {
+ $services[] = $loader->fromSession($s);
+ }
+ return array('services' => $services);
+ }
+
+ function prepareForSave($obj)
+ {
+ $loader = new Auth_OpenID_ServiceEndpointLoader();
+ $services = array();
+ foreach ($obj->services as $s) {
+ $services[] = $loader->toSession($s);
+ }
+ return array('services' => $services);
+ }
+}
+
+/**
+ * The Yadis service manager which stores state in a session and
+ * iterates over <Service> elements in a Yadis XRDS document and lets
+ * a caller attempt to use each one. This is used by the Yadis
+ * library internally.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_Manager {
+
+ /**
+ * Intialize a new yadis service manager.
+ *
+ * @access private
+ */
+ function Auth_Yadis_Manager($starting_url, $yadis_url,
+ $services, $session_key)
+ {
+ // The URL that was used to initiate the Yadis protocol
+ $this->starting_url = $starting_url;
+
+ // The URL after following redirects (the identifier)
+ $this->yadis_url = $yadis_url;
+
+ // List of service elements
+ $this->services = $services;
+
+ $this->session_key = $session_key;
+
+ // Reference to the current service object
+ $this->_current = null;
+
+ // Stale flag for cleanup if PHP lib has trouble.
+ $this->stale = false;
+ }
+
+ /**
+ * @access private
+ */
+ function length()
+ {
+ // How many untried services remain?
+ return count($this->services);
+ }
+
+ /**
+ * Return the next service
+ *
+ * $this->current() will continue to return that service until the
+ * next call to this method.
+ */
+ function nextService()
+ {
+
+ if ($this->services) {
+ $this->_current = array_shift($this->services);
+ } else {
+ $this->_current = null;
+ }
+
+ return $this->_current;
+ }
+
+ /**
+ * @access private
+ */
+ function current()
+ {
+ // Return the current service.
+ // Returns None if there are no services left.
+ return $this->_current;
+ }
+
+ /**
+ * @access private
+ */
+ function forURL($url)
+ {
+ return in_array($url, array($this->starting_url, $this->yadis_url));
+ }
+
+ /**
+ * @access private
+ */
+ function started()
+ {
+ // Has the first service been returned?
+ return $this->_current !== null;
+ }
+}
+
+/**
+ * State management for discovery.
+ *
+ * High-level usage pattern is to call .getNextService(discover) in
+ * order to find the next available service for this user for this
+ * session. Once a request completes, call .cleanup() to clean up the
+ * session state.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_Discovery {
+
+ /**
+ * @access private
+ */
+ var $DEFAULT_SUFFIX = 'auth';
+
+ /**
+ * @access private
+ */
+ var $PREFIX = '_yadis_services_';
+
+ /**
+ * Initialize a discovery object.
+ *
+ * @param Auth_Yadis_PHPSession $session An object which
+ * implements the Auth_Yadis_PHPSession API.
+ * @param string $url The URL on which to attempt discovery.
+ * @param string $session_key_suffix The optional session key
+ * suffix override.
+ */
+ function Auth_Yadis_Discovery($session, $url,
+ $session_key_suffix = null)
+ {
+ /// Initialize a discovery object
+ $this->session = $session;
+ $this->url = $url;
+ if ($session_key_suffix === null) {
+ $session_key_suffix = $this->DEFAULT_SUFFIX;
+ }
+
+ $this->session_key_suffix = $session_key_suffix;
+ $this->session_key = $this->PREFIX . $this->session_key_suffix;
+ }
+
+ /**
+ * Return the next authentication service for the pair of
+ * user_input and session. This function handles fallback.
+ */
+ function getNextService($discover_cb, $fetcher)
+ {
+ $manager = $this->getManager();
+ if (!$manager || (!$manager->services)) {
+ $this->destroyManager();
+
+ list($yadis_url, $services) = call_user_func($discover_cb,
+ $this->url,
+ &$fetcher);
+
+ $manager = $this->createManager($services, $yadis_url);
+ }
+
+ if ($manager) {
+ $loader = new Auth_Yadis_ManagerLoader();
+ $service = $manager->nextService();
+ $this->session->set($this->session_key,
+ serialize($loader->toSession($manager)));
+ } else {
+ $service = null;
+ }
+
+ return $service;
+ }
+
+ /**
+ * Clean up Yadis-related services in the session and return the
+ * most-recently-attempted service from the manager, if one
+ * exists.
+ *
+ * @param $force True if the manager should be deleted regardless
+ * of whether it's a manager for $this->url.
+ */
+ function cleanup($force=false)
+ {
+ $manager = $this->getManager($force);
+ if ($manager) {
+ $service = $manager->current();
+ $this->destroyManager($force);
+ } else {
+ $service = null;
+ }
+
+ return $service;
+ }
+
+ /**
+ * @access private
+ */
+ function getSessionKey()
+ {
+ // Get the session key for this starting URL and suffix
+ return $this->PREFIX . $this->session_key_suffix;
+ }
+
+ /**
+ * @access private
+ *
+ * @param $force True if the manager should be returned regardless
+ * of whether it's a manager for $this->url.
+ */
+ function getManager($force=false)
+ {
+ // Extract the YadisServiceManager for this object's URL and
+ // suffix from the session.
+
+ $manager_str = $this->session->get($this->getSessionKey());
+ $manager = null;
+
+ if ($manager_str !== null) {
+ $loader = new Auth_Yadis_ManagerLoader();
+ $manager = $loader->fromSession(unserialize($manager_str));
+ }
+
+ if ($manager && ($manager->forURL($this->url) || $force)) {
+ return $manager;
+ }
+ }
+
+ /**
+ * @access private
+ */
+ function createManager($services, $yadis_url = null)
+ {
+ $key = $this->getSessionKey();
+ if ($this->getManager()) {
+ return $this->getManager();
+ }
+
+ if ($services) {
+ $loader = new Auth_Yadis_ManagerLoader();
+ $manager = new Auth_Yadis_Manager($this->url, $yadis_url,
+ $services, $key);
+ $this->session->set($this->session_key,
+ serialize($loader->toSession($manager)));
+ return $manager;
+ }
+ }
+
+ /**
+ * @access private
+ *
+ * @param $force True if the manager should be deleted regardless
+ * of whether it's a manager for $this->url.
+ */
+ function destroyManager($force=false)
+ {
+ if ($this->getManager($force) !== null) {
+ $key = $this->getSessionKey();
+ $this->session->del($key);
+ }
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/Misc.php
@@ -1,1 +1,59 @@
+<?php
+/**
+ * Miscellaneous utility values and functions for OpenID and Yadis.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+function Auth_Yadis_getUCSChars()
+{
+ return array(
+ array(0xA0, 0xD7FF),
+ array(0xF900, 0xFDCF),
+ array(0xFDF0, 0xFFEF),
+ array(0x10000, 0x1FFFD),
+ array(0x20000, 0x2FFFD),
+ array(0x30000, 0x3FFFD),
+ array(0x40000, 0x4FFFD),
+ array(0x50000, 0x5FFFD),
+ array(0x60000, 0x6FFFD),
+ array(0x70000, 0x7FFFD),
+ array(0x80000, 0x8FFFD),
+ array(0x90000, 0x9FFFD),
+ array(0xA0000, 0xAFFFD),
+ array(0xB0000, 0xBFFFD),
+ array(0xC0000, 0xCFFFD),
+ array(0xD0000, 0xDFFFD),
+ array(0xE1000, 0xEFFFD)
+ );
+}
+
+function Auth_Yadis_getIPrivateChars()
+{
+ return array(
+ array(0xE000, 0xF8FF),
+ array(0xF0000, 0xFFFFD),
+ array(0x100000, 0x10FFFD)
+ );
+}
+
+function Auth_Yadis_pct_escape_unicode($char_match)
+{
+ $c = $char_match[0];
+ $result = "";
+ for ($i = 0; $i < strlen($c); $i++) {
+ $result .= "%".sprintf("%X", ord($c[$i]));
+ }
+ return $result;
+}
+
+function Auth_Yadis_startswith($s, $stuff)
+{
+ return strpos($s, $stuff) === 0;
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/ParanoidHTTPFetcher.php
@@ -1,1 +1,246 @@
-
+<?php
+
+/**
+ * This module contains the CURL-based HTTP fetcher implementation.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Interface import
+ */
+require_once "Auth/Yadis/HTTPFetcher.php";
+
+require_once "Auth/OpenID.php";
+
+/**
+ * A paranoid {@link Auth_Yadis_HTTPFetcher} class which uses CURL
+ * for fetching.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_ParanoidHTTPFetcher extends Auth_Yadis_HTTPFetcher {
+ function Auth_Yadis_ParanoidHTTPFetcher()
+ {
+ $this->reset();
+ }
+
+ function reset()
+ {
+ $this->headers = array();
+ $this->data = "";
+ }
+
+ /**
+ * @access private
+ */
+ function _writeHeader($ch, $header)
+ {
+ array_push($this->headers, rtrim($header));
+ return strlen($header);
+ }
+
+ /**
+ * @access private
+ */
+ function _writeData($ch, $data)
+ {
+ if (strlen($this->data) > 1024*Auth_OpenID_FETCHER_MAX_RESPONSE_KB) {
+ return 0;
+ } else {
+ $this->data .= $data;
+ return strlen($data);
+ }
+ }
+
+ /**
+ * Does this fetcher support SSL URLs?
+ */
+ function supportsSSL()
+ {
+ $v = curl_version();
+ if(is_array($v)) {
+ return in_array('https', $v['protocols']);
+ } elseif (is_string($v)) {
+ return preg_match('/OpenSSL/i', $v);
+ } else {
+ return 0;
+ }
+ }
+
+ function get($url, $extra_headers = null)
+ {
+ if (!$this->canFetchURL($url)) {
+ return null;
+ }
+
+ $stop = time() + $this->timeout;
+ $off = $this->timeout;
+
+ $redir = true;
+
+ while ($redir && ($off > 0)) {
+ $this->reset();
+
+ $c = curl_init();
+
+ if ($c === false) {
+ Auth_OpenID::log(
+ "curl_init returned false; could not " .
+ "initialize for URL '%s'", $url);
+ return null;
+ }
+
+ if (defined('CURLOPT_NOSIGNAL')) {
+ curl_setopt($c, CURLOPT_NOSIGNAL, true);
+ }
+
+ if (!$this->allowedURL($url)) {
+ Auth_OpenID::log("Fetching URL not allowed: %s",
+ $url);
+ return null;
+ }
+
+ curl_setopt($c, CURLOPT_WRITEFUNCTION,
+ array($this, "_writeData"));
+ curl_setopt($c, CURLOPT_HEADERFUNCTION,
+ array($this, "_writeHeader"));
+
+ if ($extra_headers) {
+ curl_setopt($c, CURLOPT_HTTPHEADER, $extra_headers);
+ }
+
+ $cv = curl_version();
+ if(is_array($cv)) {
+ $curl_user_agent = 'curl/'.$cv['version'];
+ } else {
+ $curl_user_agent = $cv;
+ }
+ curl_setopt($c, CURLOPT_USERAGENT,
+ Auth_OpenID_USER_AGENT.' '.$curl_user_agent);
+ curl_setopt($c, CURLOPT_TIMEOUT, $off);
+ curl_setopt($c, CURLOPT_URL, $url);
+
+ if (defined('Auth_OpenID_VERIFY_HOST')) {
+ curl_setopt($c, CURLOPT_SSL_VERIFYPEER, true);
+ curl_setopt($c, CURLOPT_SSL_VERIFYHOST, 2);
+ }
+ curl_exec($c);
+
+ $code = curl_getinfo($c, CURLINFO_HTTP_CODE);
+ $body = $this->data;
+ $headers = $this->headers;
+
+ if (!$code) {
+ Auth_OpenID::log("Got no response code when fetching %s", $url);
+ Auth_OpenID::log("CURL error (%s): %s",
+ curl_errno($c), curl_error($c));
+ return null;
+ }
+
+ if (in_array($code, array(301, 302, 303, 307))) {
+ $url = $this->_findRedirect($headers, $url);
+ $redir = true;
+ } else {
+ $redir = false;
+ curl_close($c);
+
+ if (defined('Auth_OpenID_VERIFY_HOST') &&
+ $this->isHTTPS($url)) {
+ Auth_OpenID::log('OpenID: Verified SSL host %s using '.
+ 'curl/get', $url);
+ }
+ $new_headers = array();
+
+ foreach ($headers as $header) {
+ if (strpos($header, ': ')) {
+ list($name, $value) = explode(': ', $header, 2);
+ $new_headers[$name] = $value;
+ }
+ }
+
+ Auth_OpenID::log(
+ "Successfully fetched '%s': GET response code %s",
+ $url, $code);
+
+ return new Auth_Yadis_HTTPResponse($url, $code,
+ $new_headers, $body);
+ }
+
+ $off = $stop - time();
+ }
+
+ return null;
+ }
+
+ function post($url, $body, $extra_headers = null)
+ {
+ if (!$this->canFetchURL($url)) {
+ return null;
+ }
+
+ $this->reset();
+
+ $c = curl_init();
+
+ if (defined('CURLOPT_NOSIGNAL')) {
+ curl_setopt($c, CURLOPT_NOSIGNAL, true);
+ }
+
+ curl_setopt($c, CURLOPT_POST, true);
+ curl_setopt($c, CURLOPT_POSTFIELDS, $body);
+ curl_setopt($c, CURLOPT_TIMEOUT, $this->timeout);
+ curl_setopt($c, CURLOPT_URL, $url);
+ curl_setopt($c, CURLOPT_WRITEFUNCTION,
+ array($this, "_writeData"));
+
+ if (defined('Auth_OpenID_VERIFY_HOST')) {
+ curl_setopt($c, CURLOPT_SSL_VERIFYPEER, true);
+ curl_setopt($c, CURLOPT_SSL_VERIFYHOST, 2);
+ }
+
+ curl_exec($c);
+
+ $code = curl_getinfo($c, CURLINFO_HTTP_CODE);
+
+ if (!$code) {
+ Auth_OpenID::log("Got no response code when fetching %s", $url);
+ Auth_OpenID::log("CURL error (%s): %s",
+ curl_errno($c), curl_error($c));
+ return null;
+ }
+
+ if (defined('Auth_OpenID_VERIFY_HOST') && $this->isHTTPS($url)) {
+ Auth_OpenID::log('OpenID: Verified SSL host %s using '.
+ 'curl/post', $url);
+ }
+ $body = $this->data;
+
+ curl_close($c);
+
+ $new_headers = $extra_headers;
+
+ foreach ($this->headers as $header) {
+ if (strpos($header, ': ')) {
+ list($name, $value) = explode(': ', $header, 2);
+ $new_headers[$name] = $value;
+ }
+
+ }
+
+ Auth_OpenID::log("Successfully fetched '%s': POST response code %s",
+ $url, $code);
+
+ return new Auth_Yadis_HTTPResponse($url, $code,
+ $new_headers, $body);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/ParseHTML.php
@@ -1,1 +1,259 @@
-
+<?php
+
+/**
+ * This is the HTML pseudo-parser for the Yadis library.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * This class is responsible for scanning an HTML string to find META
+ * tags and their attributes. This is used by the Yadis discovery
+ * process. This class must be instantiated to be used.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_ParseHTML {
+
+ /**
+ * @access private
+ */
+ var $_re_flags = "si";
+
+ /**
+ * @access private
+ */
+ var $_removed_re =
+ "<!--.*?-->|<!\[CDATA\[.*?\]\]>|<script\b(?!:)[^>]*>.*?<\/script>";
+
+ /**
+ * @access private
+ */
+ var $_tag_expr = "<%s%s(?:\s.*?)?%s>";
+
+ /**
+ * @access private
+ */
+ var $_attr_find = '\b([-\w]+)=(".*?"|\'.*?\'|.+?)[\/\s>]';
+
+ function Auth_Yadis_ParseHTML()
+ {
+ $this->_attr_find = sprintf("/%s/%s",
+ $this->_attr_find,
+ $this->_re_flags);
+
+ $this->_removed_re = sprintf("/%s/%s",
+ $this->_removed_re,
+ $this->_re_flags);
+
+ $this->_entity_replacements = array(
+ 'amp' => '&',
+ 'lt' => '<',
+ 'gt' => '>',
+ 'quot' => '"'
+ );
+
+ $this->_ent_replace =
+ sprintf("&(%s);", implode("|",
+ $this->_entity_replacements));
+ }
+
+ /**
+ * Replace HTML entities (amp, lt, gt, and quot) as well as
+ * numeric entities (e.g. #x9f;) with their actual values and
+ * return the new string.
+ *
+ * @access private
+ * @param string $str The string in which to look for entities
+ * @return string $new_str The new string entities decoded
+ */
+ function replaceEntities($str)
+ {
+ foreach ($this->_entity_replacements as $old => $new) {
+ $str = preg_replace(sprintf("/&%s;/", $old), $new, $str);
+ }
+
+ // Replace numeric entities because html_entity_decode doesn't
+ // do it for us.
+ $str = preg_replace('~&#x([0-9a-f]+);~ei', 'chr(hexdec("\\1"))', $str);
+ $str = preg_replace('~&#([0-9]+);~e', 'chr(\\1)', $str);
+
+ return $str;
+ }
+
+ /**
+ * Strip single and double quotes off of a string, if they are
+ * present.
+ *
+ * @access private
+ * @param string $str The original string
+ * @return string $new_str The new string with leading and
+ * trailing quotes removed
+ */
+ function removeQuotes($str)
+ {
+ $matches = array();
+ $double = '/^"(.*)"$/';
+ $single = "/^\'(.*)\'$/";
+
+ if (preg_match($double, $str, $matches)) {
+ return $matches[1];
+ } else if (preg_match($single, $str, $matches)) {
+ return $matches[1];
+ } else {
+ return $str;
+ }
+ }
+
+ /**
+ * Create a regular expression that will match an opening
+ * or closing tag from a set of names.
+ *
+ * @access private
+ * @param mixed $tag_names Tag names to match
+ * @param mixed $close false/0 = no, true/1 = yes, other = maybe
+ * @param mixed $self_close false/0 = no, true/1 = yes, other = maybe
+ * @return string $regex A regular expression string to be used
+ * in, say, preg_match.
+ */
+ function tagPattern($tag_names, $close, $self_close)
+ {
+ if (is_array($tag_names)) {
+ $tag_names = '(?:'.implode('|',$tag_names).')';
+ }
+ if ($close) {
+ $close = '\/' . (($close == 1)? '' : '?');
+ } else {
+ $close = '';
+ }
+ if ($self_close) {
+ $self_close = '(?:\/\s*)' . (($self_close == 1)? '' : '?');
+ } else {
+ $self_close = '';
+ }
+ $expr = sprintf($this->_tag_expr, $close, $tag_names, $self_close);
+
+ return sprintf("/%s/%s", $expr, $this->_re_flags);
+ }
+
+ /**
+ * Given an HTML document string, this finds all the META tags in
+ * the document, provided they are found in the
+ * <HTML><HEAD>...</HEAD> section of the document. The <HTML> tag
+ * may be missing.
+ *
+ * @access private
+ * @param string $html_string An HTMl document string
+ * @return array $tag_list Array of tags; each tag is an array of
+ * attribute -> value.
+ */
+ function getMetaTags($html_string)
+ {
+ $html_string = preg_replace($this->_removed_re,
+ "",
+ $html_string);
+
+ $key_tags = array($this->tagPattern('html', false, false),
+ $this->tagPattern('head', false, false),
+ $this->tagPattern('head', true, false),
+ $this->tagPattern('html', true, false),
+ $this->tagPattern(array(
+ 'body', 'frameset', 'frame', 'p', 'div',
+ 'table','span','a'), 'maybe', 'maybe'));
+ $key_tags_pos = array();
+ foreach ($key_tags as $pat) {
+ $matches = array();
+ preg_match($pat, $html_string, $matches, PREG_OFFSET_CAPTURE);
+ if($matches) {
+ $key_tags_pos[] = $matches[0][1];
+ } else {
+ $key_tags_pos[] = null;
+ }
+ }
+ // no opening head tag
+ if (is_null($key_tags_pos[1])) {
+ return array();
+ }
+ // the effective </head> is the min of the following
+ if (is_null($key_tags_pos[2])) {
+ $key_tags_pos[2] = strlen($html_string);
+ }
+ foreach (array($key_tags_pos[3], $key_tags_pos[4]) as $pos) {
+ if (!is_null($pos) && $pos < $key_tags_pos[2]) {
+ $key_tags_pos[2] = $pos;
+ }
+ }
+ // closing head tag comes before opening head tag
+ if ($key_tags_pos[1] > $key_tags_pos[2]) {
+ return array();
+ }
+ // if there is an opening html tag, make sure the opening head tag
+ // comes after it
+ if (!is_null($key_tags_pos[0]) && $key_tags_pos[1] < $key_tags_pos[0]) {
+ return array();
+ }
+ $html_string = substr($html_string, $key_tags_pos[1],
+ ($key_tags_pos[2]-$key_tags_pos[1]));
+
+ $link_data = array();
+ $link_matches = array();
+
+ if (!preg_match_all($this->tagPattern('meta', false, 'maybe'),
+ $html_string, $link_matches)) {
+ return array();
+ }
+
+ foreach ($link_matches[0] as $link) {
+ $attr_matches = array();
+ preg_match_all($this->_attr_find, $link, $attr_matches);
+ $link_attrs = array();
+ foreach ($attr_matches[0] as $index => $full_match) {
+ $name = $attr_matches[1][$index];
+ $value = $this->replaceEntities(
+ $this->removeQuotes($attr_matches[2][$index]));
+
+ $link_attrs[strtolower($name)] = $value;
+ }
+ $link_data[] = $link_attrs;
+ }
+
+ return $link_data;
+ }
+
+ /**
+ * Looks for a META tag with an "http-equiv" attribute whose value
+ * is one of ("x-xrds-location", "x-yadis-location"), ignoring
+ * case. If such a META tag is found, its "content" attribute
+ * value is returned.
+ *
+ * @param string $html_string An HTML document in string format
+ * @return mixed $content The "content" attribute value of the
+ * META tag, if found, or null if no such tag was found.
+ */
+ function getHTTPEquiv($html_string)
+ {
+ $meta_tags = $this->getMetaTags($html_string);
+
+ if ($meta_tags) {
+ foreach ($meta_tags as $tag) {
+ if (array_key_exists('http-equiv', $tag) &&
+ (in_array(strtolower($tag['http-equiv']),
+ array('x-xrds-location', 'x-yadis-location'))) &&
+ array_key_exists('content', $tag)) {
+ return $tag['content'];
+ }
+ }
+ }
+
+ return null;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/PlainHTTPFetcher.php
@@ -1,1 +1,249 @@
-
+<?php
+
+/**
+ * This module contains the plain non-curl HTTP fetcher
+ * implementation.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Interface import
+ */
+require_once "Auth/Yadis/HTTPFetcher.php";
+
+/**
+ * This class implements a plain, hand-built socket-based fetcher
+ * which will be used in the event that CURL is unavailable.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_PlainHTTPFetcher extends Auth_Yadis_HTTPFetcher {
+ /**
+ * Does this fetcher support SSL URLs?
+ */
+ function supportsSSL()
+ {
+ return function_exists('openssl_open');
+ }
+
+ function get($url, $extra_headers = null)
+ {
+ if (!$this->canFetchURL($url)) {
+ return null;
+ }
+
+ $redir = true;
+
+ $stop = time() + $this->timeout;
+ $off = $this->timeout;
+
+ while ($redir && ($off > 0)) {
+
+ $parts = parse_url($url);
+
+ $specify_port = true;
+
+ // Set a default port.
+ if (!array_key_exists('port', $parts)) {
+ $specify_port = false;
+ if ($parts['scheme'] == 'http') {
+ $parts['port'] = 80;
+ } elseif ($parts['scheme'] == 'https') {
+ $parts['port'] = 443;
+ } else {
+ return null;
+ }
+ }
+
+ if (!array_key_exists('path', $parts)) {
+ $parts['path'] = '/';
+ }
+
+ $host = $parts['host'];
+
+ if ($parts['scheme'] == 'https') {
+ $host = 'ssl://' . $host;
+ }
+
+ $user_agent = Auth_OpenID_USER_AGENT;
+
+ $headers = array(
+ "GET ".$parts['path'].
+ (array_key_exists('query', $parts) ?
+ "?".$parts['query'] : "").
+ " HTTP/1.0",
+ "User-Agent: $user_agent",
+ "Host: ".$parts['host'].
+ ($specify_port ? ":".$parts['port'] : ""),
+ "Port: ".$parts['port']);
+
+ $errno = 0;
+ $errstr = '';
+
+ if ($extra_headers) {
+ foreach ($extra_headers as $h) {
+ $headers[] = $h;
+ }
+ }
+
+ @$sock = fsockopen($host, $parts['port'], $errno, $errstr,
+ $this->timeout);
+ if ($sock === false) {
+ return false;
+ }
+
+ stream_set_timeout($sock, $this->timeout);
+
+ fputs($sock, implode("\r\n", $headers) . "\r\n\r\n");
+
+ $data = "";
+ $kilobytes = 0;
+ while (!feof($sock) &&
+ $kilobytes < Auth_OpenID_FETCHER_MAX_RESPONSE_KB ) {
+ $data .= fgets($sock, 1024);
+ $kilobytes += 1;
+ }
+
+ fclose($sock);
+
+ // Split response into header and body sections
+ list($headers, $body) = explode("\r\n\r\n", $data, 2);
+ $headers = explode("\r\n", $headers);
+
+ $http_code = explode(" ", $headers[0]);
+ $code = $http_code[1];
+
+ if (in_array($code, array('301', '302'))) {
+ $url = $this->_findRedirect($headers, $url);
+ $redir = true;
+ } else {
+ $redir = false;
+ }
+
+ $off = $stop - time();
+ }
+
+ $new_headers = array();
+
+ foreach ($headers as $header) {
+ if (preg_match("/:/", $header)) {
+ $parts = explode(": ", $header, 2);
+
+ if (count($parts) == 2) {
+ list($name, $value) = $parts;
+ $new_headers[$name] = $value;
+ }
+ }
+
+ }
+
+ return new Auth_Yadis_HTTPResponse($url, $code, $new_headers, $body);
+ }
+
+ function post($url, $body, $extra_headers = null)
+ {
+ if (!$this->canFetchURL($url)) {
+ return null;
+ }
+
+ $parts = parse_url($url);
+
+ $headers = array();
+
+ $post_path = $parts['path'];
+ if (isset($parts['query'])) {
+ $post_path .= '?' . $parts['query'];
+ }
+
+ $headers[] = "POST ".$post_path." HTTP/1.0";
+ $headers[] = "Host: " . $parts['host'];
+ $headers[] = "Content-type: application/x-www-form-urlencoded";
+ $headers[] = "Content-length: " . strval(strlen($body));
+
+ if ($extra_headers &&
+ is_array($extra_headers)) {
+ $headers = array_merge($headers, $extra_headers);
+ }
+
+ // Join all headers together.
+ $all_headers = implode("\r\n", $headers);
+
+ // Add headers, two newlines, and request body.
+ $request = $all_headers . "\r\n\r\n" . $body;
+
+ // Set a default port.
+ if (!array_key_exists('port', $parts)) {
+ if ($parts['scheme'] == 'http') {
+ $parts['port'] = 80;
+ } elseif ($parts['scheme'] == 'https') {
+ $parts['port'] = 443;
+ } else {
+ return null;
+ }
+ }
+
+ if ($parts['scheme'] == 'https') {
+ $parts['host'] = sprintf("ssl://%s", $parts['host']);
+ }
+
+ // Connect to the remote server.
+ $errno = 0;
+ $errstr = '';
+
+ $sock = fsockopen($parts['host'], $parts['port'], $errno, $errstr,
+ $this->timeout);
+
+ if ($sock === false) {
+ return null;
+ }
+
+ stream_set_timeout($sock, $this->timeout);
+
+ // Write the POST request.
+ fputs($sock, $request);
+
+ // Get the response from the server.
+ $response = "";
+ while (!feof($sock)) {
+ if ($data = fgets($sock, 128)) {
+ $response .= $data;
+ } else {
+ break;
+ }
+ }
+
+ // Split the request into headers and body.
+ list($headers, $response_body) = explode("\r\n\r\n", $response, 2);
+
+ $headers = explode("\r\n", $headers);
+
+ // Expect the first line of the headers data to be something
+ // like HTTP/1.1 200 OK. Split the line on spaces and take
+ // the second token, which should be the return code.
+ $http_code = explode(" ", $headers[0]);
+ $code = $http_code[1];
+
+ $new_headers = array();
+
+ foreach ($headers as $header) {
+ if (preg_match("/:/", $header)) {
+ list($name, $value) = explode(": ", $header, 2);
+ $new_headers[$name] = $value;
+ }
+
+ }
+
+ return new Auth_Yadis_HTTPResponse($url, $code,
+ $new_headers, $response_body);
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/XML.php
@@ -1,1 +1,353 @@
-
+<?php
+
+/**
+ * XML-parsing classes to wrap the domxml and DOM extensions for PHP 4
+ * and 5, respectively.
+ *
+ * @package OpenID
+ */
+
+/**
+ * The base class for wrappers for available PHP XML-parsing
+ * extensions. To work with this Yadis library, subclasses of this
+ * class MUST implement the API as defined in the remarks for this
+ * class. Subclasses of Auth_Yadis_XMLParser are used to wrap
+ * particular PHP XML extensions such as 'domxml'. These are used
+ * internally by the library depending on the availability of
+ * supported PHP XML extensions.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_XMLParser {
+ /**
+ * Initialize an instance of Auth_Yadis_XMLParser with some
+ * XML and namespaces. This SHOULD NOT be overridden by
+ * subclasses.
+ *
+ * @param string $xml_string A string of XML to be parsed.
+ * @param array $namespace_map An array of ($ns_name => $ns_uri)
+ * to be registered with the XML parser. May be empty.
+ * @return boolean $result True if the initialization and
+ * namespace registration(s) succeeded; false otherwise.
+ */
+ function init($xml_string, $namespace_map)
+ {
+ if (!$this->setXML($xml_string)) {
+ return false;
+ }
+
+ foreach ($namespace_map as $prefix => $uri) {
+ if (!$this->registerNamespace($prefix, $uri)) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Register a namespace with the XML parser. This should be
+ * overridden by subclasses.
+ *
+ * @param string $prefix The namespace prefix to appear in XML tag
+ * names.
+ *
+ * @param string $uri The namespace URI to be used to identify the
+ * namespace in the XML.
+ *
+ * @return boolean $result True if the registration succeeded;
+ * false otherwise.
+ */
+ function registerNamespace($prefix, $uri)
+ {
+ // Not implemented.
+ }
+
+ /**
+ * Set this parser object's XML payload. This should be
+ * overridden by subclasses.
+ *
+ * @param string $xml_string The XML string to pass to this
+ * object's XML parser.
+ *
+ * @return boolean $result True if the initialization succeeded;
+ * false otherwise.
+ */
+ function setXML($xml_string)
+ {
+ // Not implemented.
+ }
+
+ /**
+ * Evaluate an XPath expression and return the resulting node
+ * list. This should be overridden by subclasses.
+ *
+ * @param string $xpath The XPath expression to be evaluated.
+ *
+ * @param mixed $node A node object resulting from a previous
+ * evalXPath call. This node, if specified, provides the context
+ * for the evaluation of this xpath expression.
+ *
+ * @return array $node_list An array of matching opaque node
+ * objects to be used with other methods of this parser class.
+ */
+ function &evalXPath($xpath, $node = null)
+ {
+ // Not implemented.
+ }
+
+ /**
+ * Return the textual content of a specified node.
+ *
+ * @param mixed $node A node object from a previous call to
+ * $this->evalXPath().
+ *
+ * @return string $content The content of this node.
+ */
+ function content($node)
+ {
+ // Not implemented.
+ }
+
+ /**
+ * Return the attributes of a specified node.
+ *
+ * @param mixed $node A node object from a previous call to
+ * $this->evalXPath().
+ *
+ * @return array $attrs An array mapping attribute names to
+ * values.
+ */
+ function attributes($node)
+ {
+ // Not implemented.
+ }
+}
+
+/**
+ * This concrete implementation of Auth_Yadis_XMLParser implements
+ * the appropriate API for the 'domxml' extension which is typically
+ * packaged with PHP 4. This class will be used whenever the 'domxml'
+ * extension is detected. See the Auth_Yadis_XMLParser class for
+ * details on this class's methods.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_domxml extends Auth_Yadis_XMLParser {
+ function Auth_Yadis_domxml()
+ {
+ $this->xml = null;
+ $this->doc = null;
+ $this->xpath = null;
+ $this->errors = array();
+ }
+
+ function setXML($xml_string)
+ {
+ $this->xml = $xml_string;
+ $this->doc = @domxml_open_mem($xml_string, DOMXML_LOAD_PARSING,
+ $this->errors);
+
+ if (!$this->doc) {
+ return false;
+ }
+
+ $this->xpath = $this->doc->xpath_new_context();
+
+ return true;
+ }
+
+ function registerNamespace($prefix, $uri)
+ {
+ return xpath_register_ns($this->xpath, $prefix, $uri);
+ }
+
+ function &evalXPath($xpath, $node = null)
+ {
+ if ($node) {
+ $result = @$this->xpath->xpath_eval($xpath, $node);
+ } else {
+ $result = @$this->xpath->xpath_eval($xpath);
+ }
+
+ if (!$result) {
+ $n = array();
+ return $n;
+ }
+
+ if (!$result->nodeset) {
+ $n = array();
+ return $n;
+ }
+
+ return $result->nodeset;
+ }
+
+ function content($node)
+ {
+ if ($node) {
+ return $node->get_content();
+ }
+ }
+
+ function attributes($node)
+ {
+ if ($node) {
+ $arr = $node->attributes();
+ $result = array();
+
+ if ($arr) {
+ foreach ($arr as $attrnode) {
+ $result[$attrnode->name] = $attrnode->value;
+ }
+ }
+
+ return $result;
+ }
+ }
+}
+
+/**
+ * This concrete implementation of Auth_Yadis_XMLParser implements
+ * the appropriate API for the 'dom' extension which is typically
+ * packaged with PHP 5. This class will be used whenever the 'dom'
+ * extension is detected. See the Auth_Yadis_XMLParser class for
+ * details on this class's methods.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_dom extends Auth_Yadis_XMLParser {
+ function Auth_Yadis_dom()
+ {
+ $this->xml = null;
+ $this->doc = null;
+ $this->xpath = null;
+ $this->errors = array();
+ }
+
+ function setXML($xml_string)
+ {
+ $this->xml = $xml_string;
+ $this->doc = new DOMDocument;
+
+ if (!$this->doc) {
+ return false;
+ }
+
+ if (!@$this->doc->loadXML($xml_string)) {
+ return false;
+ }
+
+ $this->xpath = new DOMXPath($this->doc);
+
+ if ($this->xpath) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ function registerNamespace($prefix, $uri)
+ {
+ return $this->xpath->registerNamespace($prefix, $uri);
+ }
+
+ function &evalXPath($xpath, $node = null)
+ {
+ if ($node) {
+ $result = @$this->xpath->query($xpath, $node);
+ } else {
+ $result = @$this->xpath->query($xpath);
+ }
+
+ $n = array();
+
+ if (!$result) {
+ return $n;
+ }
+
+ for ($i = 0; $i < $result->length; $i++) {
+ $n[] = $result->item($i);
+ }
+
+ return $n;
+ }
+
+ function content($node)
+ {
+ if ($node) {
+ return $node->textContent;
+ }
+ }
+
+ function attributes($node)
+ {
+ if ($node) {
+ $arr = $node->attributes;
+ $result = array();
+
+ if ($arr) {
+ for ($i = 0; $i < $arr->length; $i++) {
+ $node = $arr->item($i);
+ $result[$node->nodeName] = $node->nodeValue;
+ }
+ }
+
+ return $result;
+ }
+ }
+}
+
+global $__Auth_Yadis_defaultParser;
+$__Auth_Yadis_defaultParser = null;
+
+/**
+ * Set a default parser to override the extension-driven selection of
+ * available parser classes. This is helpful in a test environment or
+ * one in which multiple parsers can be used but one is more
+ * desirable.
+ *
+ * @param Auth_Yadis_XMLParser $parser An instance of a
+ * Auth_Yadis_XMLParser subclass.
+ */
+function Auth_Yadis_setDefaultParser($parser)
+{
+ global $__Auth_Yadis_defaultParser;
+ $__Auth_Yadis_defaultParser = $parser;
+}
+
+function Auth_Yadis_getSupportedExtensions()
+{
+ return array('dom' => 'Auth_Yadis_dom',
+ 'domxml' => 'Auth_Yadis_domxml');
+}
+
+/**
+ * Returns an instance of a Auth_Yadis_XMLParser subclass based on
+ * the availability of PHP extensions for XML parsing. If
+ * Auth_Yadis_setDefaultParser has been called, the parser used in
+ * that call will be returned instead.
+ */
+function Auth_Yadis_getXMLParser()
+{
+ global $__Auth_Yadis_defaultParser;
+
+ if (isset($__Auth_Yadis_defaultParser)) {
+ return $__Auth_Yadis_defaultParser;
+ }
+
+ foreach(Auth_Yadis_getSupportedExtensions() as $extension => $classname)
+ {
+ if (extension_loaded($extension))
+ {
+ $p = new $classname();
+ Auth_Yadis_setDefaultParser($p);
+ return $p;
+ }
+ }
+
+ return false;
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/XRDS.php
@@ -1,1 +1,479 @@
-
+<?php
+
+/**
+ * This module contains the XRDS parsing code.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Require the XPath implementation.
+ */
+require_once 'Auth/Yadis/XML.php';
+
+/**
+ * This match mode means a given service must match ALL filters passed
+ * to the Auth_Yadis_XRDS::services() call.
+ */
+define('SERVICES_YADIS_MATCH_ALL', 101);
+
+/**
+ * This match mode means a given service must match ANY filters (at
+ * least one) passed to the Auth_Yadis_XRDS::services() call.
+ */
+define('SERVICES_YADIS_MATCH_ANY', 102);
+
+/**
+ * The priority value used for service elements with no priority
+ * specified.
+ */
+define('SERVICES_YADIS_MAX_PRIORITY', pow(2, 30));
+
+/**
+ * XRD XML namespace
+ */
+define('Auth_Yadis_XMLNS_XRD_2_0', 'xri://$xrd*($v*2.0)');
+
+/**
+ * XRDS XML namespace
+ */
+define('Auth_Yadis_XMLNS_XRDS', 'xri://$xrds');
+
+function Auth_Yadis_getNSMap()
+{
+ return array('xrds' => Auth_Yadis_XMLNS_XRDS,
+ 'xrd' => Auth_Yadis_XMLNS_XRD_2_0);
+}
+
+/**
+ * @access private
+ */
+function Auth_Yadis_array_scramble($arr)
+{
+ $result = array();
+
+ while (count($arr)) {
+ $index = array_rand($arr, 1);
+ $result[] = $arr[$index];
+ unset($arr[$index]);
+ }
+
+ return $result;
+}
+
+/**
+ * This class represents a <Service> element in an XRDS document.
+ * Objects of this type are returned by
+ * Auth_Yadis_XRDS::services() and
+ * Auth_Yadis_Yadis::services(). Each object corresponds directly
+ * to a <Service> element in the XRDS and supplies a
+ * getElements($name) method which you should use to inspect the
+ * element's contents. See {@link Auth_Yadis_Yadis} for more
+ * information on the role this class plays in Yadis discovery.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_Service {
+
+ /**
+ * Creates an empty service object.
+ */
+ function Auth_Yadis_Service()
+ {
+ $this->element = null;
+ $this->parser = null;
+ }
+
+ /**
+ * Return the URIs in the "Type" elements, if any, of this Service
+ * element.
+ *
+ * @return array $type_uris An array of Type URI strings.
+ */
+ function getTypes()
+ {
+ $t = array();
+ foreach ($this->getElements('xrd:Type') as $elem) {
+ $c = $this->parser->content($elem);
+ if ($c) {
+ $t[] = $c;
+ }
+ }
+ return $t;
+ }
+
+ function matchTypes($type_uris)
+ {
+ $result = array();
+
+ foreach ($this->getTypes() as $typ) {
+ if (in_array($typ, $type_uris)) {
+ $result[] = $typ;
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * Return the URIs in the "URI" elements, if any, of this Service
+ * element. The URIs are returned sorted in priority order.
+ *
+ * @return array $uris An array of URI strings.
+ */
+ function getURIs()
+ {
+ $uris = array();
+ $last = array();
+
+ foreach ($this->getElements('xrd:URI') as $elem) {
+ $uri_string = $this->parser->content($elem);
+ $attrs = $this->parser->attributes($elem);
+ if ($attrs &&
+ array_key_exists('priority', $attrs)) {
+ $priority = intval($attrs['priority']);
+ if (!array_key_exists($priority, $uris)) {
+ $uris[$priority] = array();
+ }
+
+ $uris[$priority][] = $uri_string;
+ } else {
+ $last[] = $uri_string;
+ }
+ }
+
+ $keys = array_keys($uris);
+ sort($keys);
+
+ // Rebuild array of URIs.
+ $result = array();
+ foreach ($keys as $k) {
+ $new_uris = Auth_Yadis_array_scramble($uris[$k]);
+ $result = array_merge($result, $new_uris);
+ }
+
+ $result = array_merge($result,
+ Auth_Yadis_array_scramble($last));
+
+ return $result;
+ }
+
+ /**
+ * Returns the "priority" attribute value of this <Service>
+ * element, if the attribute is present. Returns null if not.
+ *
+ * @return mixed $result Null or integer, depending on whether
+ * this Service element has a 'priority' attribute.
+ */
+ function getPriority()
+ {
+ $attributes = $this->parser->attributes($this->element);
+
+ if (array_key_exists('priority', $attributes)) {
+ return intval($attributes['priority']);
+ }
+
+ return null;
+ }
+
+ /**
+ * Used to get XML elements from this object's <Service> element.
+ *
+ * This is what you should use to get all custom information out
+ * of this element. This is used by service filter functions to
+ * determine whether a service element contains specific tags,
+ * etc. NOTE: this only considers elements which are direct
+ * children of the <Service> element for this object.
+ *
+ * @param string $name The name of the element to look for
+ * @return array $list An array of elements with the specified
+ * name which are direct children of the <Service> element. The
+ * nodes returned by this function can be passed to $this->parser
+ * methods (see {@link Auth_Yadis_XMLParser}).
+ */
+ function getElements($name)
+ {
+ return $this->parser->evalXPath($name, $this->element);
+ }
+}
+
+/*
+ * Return the expiration date of this XRD element, or None if no
+ * expiration was specified.
+ *
+ * @param $default The value to use as the expiration if no expiration
+ * was specified in the XRD.
+ */
+function Auth_Yadis_getXRDExpiration($xrd_element, $default=null)
+{
+ $expires_element = $xrd_element->$parser->evalXPath('/xrd:Expires');
+ if ($expires_element === null) {
+ return $default;
+ } else {
+ $expires_string = $expires_element->text;
+
+ // Will raise ValueError if the string is not the expected
+ // format
+ $t = strptime($expires_string, "%Y-%m-%dT%H:%M:%SZ");
+
+ if ($t === false) {
+ return false;
+ }
+
+ // [int $hour [, int $minute [, int $second [,
+ // int $month [, int $day [, int $year ]]]]]]
+ return mktime($t['tm_hour'], $t['tm_min'], $t['tm_sec'],
+ $t['tm_mon'], $t['tm_day'], $t['tm_year']);
+ }
+}
+
+/**
+ * This class performs parsing of XRDS documents.
+ *
+ * You should not instantiate this class directly; rather, call
+ * parseXRDS statically:
+ *
+ * <pre> $xrds = Auth_Yadis_XRDS::parseXRDS($xml_string);</pre>
+ *
+ * If the XRDS can be parsed and is valid, an instance of
+ * Auth_Yadis_XRDS will be returned. Otherwise, null will be
+ * returned. This class is used by the Auth_Yadis_Yadis::discover
+ * method.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_XRDS {
+
+ /**
+ * Instantiate a Auth_Yadis_XRDS object. Requires an XPath
+ * instance which has been used to parse a valid XRDS document.
+ */
+ function Auth_Yadis_XRDS($xmlParser, $xrdNodes)
+ {
+ $this->parser = $xmlParser;
+ $this->xrdNode = $xrdNodes[count($xrdNodes) - 1];
+ $this->allXrdNodes = $xrdNodes;
+ $this->serviceList = array();
+ $this->_parse();
+ }
+
+ /**
+ * Parse an XML string (XRDS document) and return either a
+ * Auth_Yadis_XRDS object or null, depending on whether the
+ * XRDS XML is valid.
+ *
+ * @param string $xml_string An XRDS XML string.
+ * @return mixed $xrds An instance of Auth_Yadis_XRDS or null,
+ * depending on the validity of $xml_string
+ */
+ static function parseXRDS($xml_string, $extra_ns_map = null)
+ {
+ $_null = null;
+
+ if (!$xml_string) {
+ return $_null;
+ }
+
+ $parser = Auth_Yadis_getXMLParser();
+
+ $ns_map = Auth_Yadis_getNSMap();
+
+ if ($extra_ns_map && is_array($extra_ns_map)) {
+ $ns_map = array_merge($ns_map, $extra_ns_map);
+ }
+
+ if (!($parser && $parser->init($xml_string, $ns_map))) {
+ return $_null;
+ }
+
+ // Try to get root element.
+ $root = $parser->evalXPath('/xrds:XRDS[1]');
+ if (!$root) {
+ return $_null;
+ }
+
+ if (is_array($root)) {
+ $root = $root[0];
+ }
+
+ $attrs = $parser->attributes($root);
+
+ if (array_key_exists('xmlns:xrd', $attrs) &&
+ $attrs['xmlns:xrd'] != Auth_Yadis_XMLNS_XRDS) {
+ return $_null;
+ } else if (array_key_exists('xmlns', $attrs) &&
+ preg_match('/xri/', $attrs['xmlns']) &&
+ $attrs['xmlns'] != Auth_Yadis_XMLNS_XRD_2_0) {
+ return $_null;
+ }
+
+ // Get the last XRD node.
+ $xrd_nodes = $parser->evalXPath('/xrds:XRDS[1]/xrd:XRD');
+
+ if (!$xrd_nodes) {
+ return $_null;
+ }
+
+ $xrds = new Auth_Yadis_XRDS($parser, $xrd_nodes);
+ return $xrds;
+ }
+
+ /**
+ * @access private
+ */
+ function _addService($priority, $service)
+ {
+ $priority = intval($priority);
+
+ if (!array_key_exists($priority, $this->serviceList)) {
+ $this->serviceList[$priority] = array();
+ }
+
+ $this->serviceList[$priority][] = $service;
+ }
+
+ /**
+ * Creates the service list using nodes from the XRDS XML
+ * document.
+ *
+ * @access private
+ */
+ function _parse()
+ {
+ $this->serviceList = array();
+
+ $services = $this->parser->evalXPath('xrd:Service', $this->xrdNode);
+
+ foreach ($services as $node) {
+ $s = new Auth_Yadis_Service();
+ $s->element = $node;
+ $s->parser = $this->parser;
+
+ $priority = $s->getPriority();
+
+ if ($priority === null) {
+ $priority = SERVICES_YADIS_MAX_PRIORITY;
+ }
+
+ $this->_addService($priority, $s);
+ }
+ }
+
+ /**
+ * Returns a list of service objects which correspond to <Service>
+ * elements in the XRDS XML document for this object.
+ *
+ * Optionally, an array of filter callbacks may be given to limit
+ * the list of returned service objects. Furthermore, the default
+ * mode is to return all service objects which match ANY of the
+ * specified filters, but $filter_mode may be
+ * SERVICES_YADIS_MATCH_ALL if you want to be sure that the
+ * returned services match all the given filters. See {@link
+ * Auth_Yadis_Yadis} for detailed usage information on filter
+ * functions.
+ *
+ * @param mixed $filters An array of callbacks to filter the
+ * returned services, or null if all services are to be returned.
+ * @param integer $filter_mode SERVICES_YADIS_MATCH_ALL or
+ * SERVICES_YADIS_MATCH_ANY, depending on whether the returned
+ * services should match ALL or ANY of the specified filters,
+ * respectively.
+ * @return mixed $services An array of {@link
+ * Auth_Yadis_Service} objects if $filter_mode is a valid
+ * mode; null if $filter_mode is an invalid mode (i.e., not
+ * SERVICES_YADIS_MATCH_ANY or SERVICES_YADIS_MATCH_ALL).
+ */
+ function services($filters = null,
+ $filter_mode = SERVICES_YADIS_MATCH_ANY)
+ {
+
+ $pri_keys = array_keys($this->serviceList);
+ sort($pri_keys, SORT_NUMERIC);
+
+ // If no filters are specified, return the entire service
+ // list, ordered by priority.
+ if (!$filters ||
+ (!is_array($filters))) {
+
+ $result = array();
+ foreach ($pri_keys as $pri) {
+ $result = array_merge($result, $this->serviceList[$pri]);
+ }
+
+ return $result;
+ }
+
+ // If a bad filter mode is specified, return null.
+ if (!in_array($filter_mode, array(SERVICES_YADIS_MATCH_ANY,
+ SERVICES_YADIS_MATCH_ALL))) {
+ return null;
+ }
+
+ // Otherwise, use the callbacks in the filter list to
+ // determine which services are returned.
+ $filtered = array();
+
+ foreach ($pri_keys as $priority_value) {
+ $service_obj_list = $this->serviceList[$priority_value];
+
+ foreach ($service_obj_list as $service) {
+
+ $matches = 0;
+
+ foreach ($filters as $filter) {
+
+ if (call_user_func_array($filter, array(&$service))) {
+ $matches++;
+
+ if ($filter_mode == SERVICES_YADIS_MATCH_ANY) {
+ $pri = $service->getPriority();
+ if ($pri === null) {
+ $pri = SERVICES_YADIS_MAX_PRIORITY;
+ }
+
+ if (!array_key_exists($pri, $filtered)) {
+ $filtered[$pri] = array();
+ }
+
+ $filtered[$pri][] = $service;
+ break;
+ }
+ }
+ }
+
+ if (($filter_mode == SERVICES_YADIS_MATCH_ALL) &&
+ ($matches == count($filters))) {
+
+ $pri = $service->getPriority();
+ if ($pri === null) {
+ $pri = SERVICES_YADIS_MAX_PRIORITY;
+ }
+
+ if (!array_key_exists($pri, $filtered)) {
+ $filtered[$pri] = array();
+ }
+ $filtered[$pri][] = $service;
+ }
+ }
+ }
+
+ $pri_keys = array_keys($filtered);
+ sort($pri_keys, SORT_NUMERIC);
+
+ $result = array();
+ foreach ($pri_keys as $pri) {
+ $result = array_merge($result, $filtered[$pri]);
+ }
+
+ return $result;
+ }
+}
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/XRI.php
@@ -1,1 +1,235 @@
-
+<?php
+
+/**
+ * Routines for XRI resolution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+require_once 'Auth/Yadis/Misc.php';
+require_once 'Auth/Yadis/Yadis.php';
+require_once 'Auth/OpenID.php';
+
+function Auth_Yadis_getDefaultProxy()
+{
+ return 'http://xri.net/';
+}
+
+function Auth_Yadis_getXRIAuthorities()
+{
+ return array('!', '=', '@', '+', '$', '(');
+}
+
+function Auth_Yadis_getEscapeRE()
+{
+ $parts = array();
+ foreach (array_merge(Auth_Yadis_getUCSChars(),
+ Auth_Yadis_getIPrivateChars()) as $pair) {
+ list($m, $n) = $pair;
+ $parts[] = sprintf("%s-%s", chr($m), chr($n));
+ }
+
+ return sprintf('/[%s]/', implode('', $parts));
+}
+
+function Auth_Yadis_getXrefRE()
+{
+ return '/\((.*?)\)/';
+}
+
+function Auth_Yadis_identifierScheme($identifier)
+{
+ if (Auth_Yadis_startswith($identifier, 'xri://') ||
+ ($identifier &&
+ in_array($identifier[0], Auth_Yadis_getXRIAuthorities()))) {
+ return "XRI";
+ } else {
+ return "URI";
+ }
+}
+
+function Auth_Yadis_toIRINormal($xri)
+{
+ if (!Auth_Yadis_startswith($xri, 'xri://')) {
+ $xri = 'xri://' . $xri;
+ }
+
+ return Auth_Yadis_escapeForIRI($xri);
+}
+
+function _escape_xref($xref_match)
+{
+ $xref = $xref_match[0];
+ $xref = str_replace('/', '%2F', $xref);
+ $xref = str_replace('?', '%3F', $xref);
+ $xref = str_replace('#', '%23', $xref);
+ return $xref;
+}
+
+function Auth_Yadis_escapeForIRI($xri)
+{
+ $xri = str_replace('%', '%25', $xri);
+ $xri = preg_replace_callback(Auth_Yadis_getXrefRE(),
+ '_escape_xref', $xri);
+ return $xri;
+}
+
+function Auth_Yadis_toURINormal($xri)
+{
+ return Auth_Yadis_iriToURI(Auth_Yadis_toIRINormal($xri));
+}
+
+function Auth_Yadis_iriToURI($iri)
+{
+ if (1) {
+ return $iri;
+ } else {
+ // According to RFC 3987, section 3.1, "Mapping of IRIs to URIs"
+ return preg_replace_callback(Auth_Yadis_getEscapeRE(),
+ 'Auth_Yadis_pct_escape_unicode', $iri);
+ }
+}
+
+
+function Auth_Yadis_XRIAppendArgs($url, $args)
+{
+ // Append some arguments to an HTTP query. Yes, this is just like
+ // OpenID's appendArgs, but with special seasoning for XRI
+ // queries.
+
+ if (count($args) == 0) {
+ return $url;
+ }
+
+ // Non-empty array; if it is an array of arrays, use multisort;
+ // otherwise use sort.
+ if (array_key_exists(0, $args) &&
+ is_array($args[0])) {
+ // Do nothing here.
+ } else {
+ $keys = array_keys($args);
+ sort($keys);
+ $new_args = array();
+ foreach ($keys as $key) {
+ $new_args[] = array($key, $args[$key]);
+ }
+ $args = $new_args;
+ }
+
+ // According to XRI Resolution section "QXRI query parameters":
+ //
+ // "If the original QXRI had a null query component (only a
+ // leading question mark), or a query component consisting of
+ // only question marks, one additional leading question mark MUST
+ // be added when adding any XRI resolution parameters."
+ if (strpos(rtrim($url, '?'), '?') !== false) {
+ $sep = '&';
+ } else {
+ $sep = '?';
+ }
+
+ return $url . $sep . Auth_OpenID::httpBuildQuery($args);
+}
+
+function Auth_Yadis_providerIsAuthoritative($providerID, $canonicalID)
+{
+ $lastbang = strrpos($canonicalID, '!');
+ $p = substr($canonicalID, 0, $lastbang);
+ return $p == $providerID;
+}
+
+function Auth_Yadis_rootAuthority($xri)
+{
+ // Return the root authority for an XRI.
+
+ $root = null;
+
+ if (Auth_Yadis_startswith($xri, 'xri://')) {
+ $xri = substr($xri, 6);
+ }
+
+ $authority = explode('/', $xri, 2);
+ $authority = $authority[0];
+ if ($authority[0] == '(') {
+ // Cross-reference.
+ // XXX: This is incorrect if someone nests cross-references so
+ // there is another close-paren in there. Hopefully nobody
+ // does that before we have a real xriparse function.
+ // Hopefully nobody does that *ever*.
+ $root = substr($authority, 0, strpos($authority, ')') + 1);
+ } else if (in_array($authority[0], Auth_Yadis_getXRIAuthorities())) {
+ // Other XRI reference.
+ $root = $authority[0];
+ } else {
+ // IRI reference.
+ $_segments = explode("!", $authority);
+ $segments = array();
+ foreach ($_segments as $s) {
+ $segments = array_merge($segments, explode("*", $s));
+ }
+ $root = $segments[0];
+ }
+
+ return Auth_Yadis_XRI($root);
+}
+
+function Auth_Yadis_XRI($xri)
+{
+ if (!Auth_Yadis_startswith($xri, 'xri://')) {
+ $xri = 'xri://' . $xri;
+ }
+ return $xri;
+}
+
+function Auth_Yadis_getCanonicalID($iname, $xrds)
+{
+ // Returns false or a canonical ID value.
+
+ // Now nodes are in reverse order.
+ $xrd_list = array_reverse($xrds->allXrdNodes);
+ $parser = $xrds->parser;
+ $node = $xrd_list[0];
+
+ $canonicalID_nodes = $parser->evalXPath('xrd:CanonicalID', $node);
+
+ if (!$canonicalID_nodes) {
+ return false;
+ }
+
+ $canonicalID = $canonicalID_nodes[0];
+ $canonicalID = Auth_Yadis_XRI($parser->content($canonicalID));
+
+ $childID = $canonicalID;
+
+ for ($i = 1; $i < count($xrd_list); $i++) {
+ $xrd = $xrd_list[$i];
+
+ $parent_sought = substr($childID, 0, strrpos($childID, '!'));
+ $parentCID = $parser->evalXPath('xrd:CanonicalID', $xrd);
+ if (!$parentCID) {
+ return false;
+ }
+ $parentCID = Auth_Yadis_XRI($parser->content($parentCID[0]));
+
+ if (strcasecmp($parent_sought, $parentCID)) {
+ // raise XRDSFraud.
+ return false;
+ }
+
+ $childID = $parent_sought;
+ }
+
+ $root = Auth_Yadis_rootAuthority($iname);
+ if (!Auth_Yadis_providerIsAuthoritative($root, $childID)) {
+ // raise XRDSFraud.
+ return false;
+ }
+
+ return $canonicalID;
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/XRIRes.php
@@ -1,1 +1,73 @@
+<?php
+/**
+ * Code for using a proxy XRI resolver.
+ */
+
+require_once 'Auth/Yadis/XRDS.php';
+require_once 'Auth/Yadis/XRI.php';
+
+class Auth_Yadis_ProxyResolver {
+ function Auth_Yadis_ProxyResolver($fetcher, $proxy_url = null)
+ {
+ $this->fetcher = $fetcher;
+ $this->proxy_url = $proxy_url;
+ if (!$this->proxy_url) {
+ $this->proxy_url = Auth_Yadis_getDefaultProxy();
+ }
+ }
+
+ function queryURL($xri, $service_type = null)
+ {
+ // trim off the xri:// prefix
+ $qxri = substr(Auth_Yadis_toURINormal($xri), 6);
+ $hxri = $this->proxy_url . $qxri;
+ $args = array(
+ '_xrd_r' => 'application/xrds+xml'
+ );
+
+ if ($service_type) {
+ $args['_xrd_t'] = $service_type;
+ } else {
+ // Don't perform service endpoint selection.
+ $args['_xrd_r'] .= ';sep=false';
+ }
+
+ $query = Auth_Yadis_XRIAppendArgs($hxri, $args);
+ return $query;
+ }
+
+ function query($xri, $service_types, $filters = array())
+ {
+ $services = array();
+ $canonicalID = null;
+ foreach ($service_types as $service_type) {
+ $url = $this->queryURL($xri, $service_type);
+ $response = $this->fetcher->get($url);
+ if ($response->status != 200 and $response->status != 206) {
+ continue;
+ }
+ $xrds = Auth_Yadis_XRDS::parseXRDS($response->body);
+ if (!$xrds) {
+ continue;
+ }
+ $canonicalID = Auth_Yadis_getCanonicalID($xri,
+ $xrds);
+
+ if ($canonicalID === false) {
+ return null;
+ }
+
+ $some_services = $xrds->services($filters);
+ $services = array_merge($services, $some_services);
+ // TODO:
+ // * If we do get hits for multiple service_types, we're
+ // almost certainly going to have duplicated service
+ // entries and broken priority ordering.
+ }
+ return array($canonicalID, $services);
+ }
+}
+
+
+
--- /dev/null
+++ b/lib/openid-php/Auth/Yadis/Yadis.php
@@ -1,1 +1,383 @@
-
+<?php
+
+/**
+ * The core PHP Yadis implementation.
+ *
+ * PHP versions 4 and 5
+ *
+ * LICENSE: See the COPYING file included in this distribution.
+ *
+ * @package OpenID
+ * @author JanRain, Inc. <openid@janrain.com>
+ * @copyright 2005-2008 Janrain, Inc.
+ * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
+ */
+
+/**
+ * Need both fetcher types so we can use the right one based on the
+ * presence or absence of CURL.
+ */
+require_once "Auth/Yadis/PlainHTTPFetcher.php";
+require_once "Auth/Yadis/ParanoidHTTPFetcher.php";
+
+/**
+ * Need this for parsing HTML (looking for META tags).
+ */
+require_once "Auth/Yadis/ParseHTML.php";
+
+/**
+ * Need this to parse the XRDS document during Yadis discovery.
+ */
+require_once "Auth/Yadis/XRDS.php";
+
+/**
+ * XRDS (yadis) content type
+ */
+define('Auth_Yadis_CONTENT_TYPE', 'application/xrds+xml');
+
+/**
+ * Yadis header
+ */
+define('Auth_Yadis_HEADER_NAME', 'X-XRDS-Location');
+
+/**
+ * Contains the result of performing Yadis discovery on a URI.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_DiscoveryResult {
+
+ // The URI that was passed to the fetcher
+ var $request_uri = null;
+
+ // The result of following redirects from the request_uri
+ var $normalized_uri = null;
+
+ // The URI from which the response text was returned (set to
+ // None if there was no XRDS document found)
+ var $xrds_uri = null;
+
+ var $xrds = null;
+
+ // The content-type returned with the response_text
+ var $content_type = null;
+
+ // The document returned from the xrds_uri
+ var $response_text = null;
+
+ // Did the discovery fail miserably?
+ var $failed = false;
+
+ function Auth_Yadis_DiscoveryResult($request_uri)
+ {
+ // Initialize the state of the object
+ // sets all attributes to None except the request_uri
+ $this->request_uri = $request_uri;
+ }
+
+ function fail()
+ {
+ $this->failed = true;
+ }
+
+ function isFailure()
+ {
+ return $this->failed;
+ }
+
+ /**
+ * Returns the list of service objects as described by the XRDS
+ * document, if this yadis object represents a successful Yadis
+ * discovery.
+ *
+ * @return array $services An array of {@link Auth_Yadis_Service}
+ * objects
+ */
+ function services()
+ {
+ if ($this->xrds) {
+ return $this->xrds->services();
+ }
+
+ return null;
+ }
+
+ function usedYadisLocation()
+ {
+ // Was the Yadis protocol's indirection used?
+ return ($this->xrds_uri && $this->normalized_uri != $this->xrds_uri);
+ }
+
+ function isXRDS()
+ {
+ // Is the response text supposed to be an XRDS document?
+ return ($this->usedYadisLocation() ||
+ $this->content_type == Auth_Yadis_CONTENT_TYPE);
+ }
+}
+
+/**
+ *
+ * Perform the Yadis protocol on the input URL and return an iterable
+ * of resulting endpoint objects.
+ *
+ * input_url: The URL on which to perform the Yadis protocol
+ *
+ * @return: The normalized identity URL and an iterable of endpoint
+ * objects generated by the filter function.
+ *
+ * xrds_parse_func: a callback which will take (uri, xrds_text) and
+ * return an array of service endpoint objects or null. Usually
+ * array('Auth_OpenID_ServiceEndpoint', 'fromXRDS').
+ *
+ * discover_func: if not null, a callback which should take (uri) and
+ * return an Auth_Yadis_Yadis object or null.
+ */
+function Auth_Yadis_getServiceEndpoints($input_url, $xrds_parse_func,
+ $discover_func=null, $fetcher=null)
+{
+ if ($discover_func === null) {
+ $discover_function = array('Auth_Yadis_Yadis', 'discover');
+ }
+
+ $yadis_result = call_user_func_array($discover_func,
+ array($input_url, &$fetcher));
+
+ if ($yadis_result === null) {
+ return array($input_url, array());
+ }
+
+ $endpoints = call_user_func_array($xrds_parse_func,
+ array($yadis_result->normalized_uri,
+ $yadis_result->response_text));
+
+ if ($endpoints === null) {
+ $endpoints = array();
+ }
+
+ return array($yadis_result->normalized_uri, $endpoints);
+}
+
+/**
+ * This is the core of the PHP Yadis library. This is the only class
+ * a user needs to use to perform Yadis discovery. This class
+ * performs the discovery AND stores the result of the discovery.
+ *
+ * First, require this library into your program source:
+ *
+ * <pre> require_once "Auth/Yadis/Yadis.php";</pre>
+ *
+ * To perform Yadis discovery, first call the "discover" method
+ * statically with a URI parameter:
+ *
+ * <pre> $http_response = array();
+ * $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
+ * $yadis_object = Auth_Yadis_Yadis::discover($uri,
+ * $http_response, $fetcher);</pre>
+ *
+ * If the discovery succeeds, $yadis_object will be an instance of
+ * {@link Auth_Yadis_Yadis}. If not, it will be null. The XRDS
+ * document found during discovery should have service descriptions,
+ * which can be accessed by calling
+ *
+ * <pre> $service_list = $yadis_object->services();</pre>
+ *
+ * which returns an array of objects which describe each service.
+ * These objects are instances of Auth_Yadis_Service. Each object
+ * describes exactly one whole Service element, complete with all of
+ * its Types and URIs (no expansion is performed). The common use
+ * case for using the service objects returned by services() is to
+ * write one or more filter functions and pass those to services():
+ *
+ * <pre> $service_list = $yadis_object->services(
+ * array("filterByURI",
+ * "filterByExtension"));</pre>
+ *
+ * The filter functions (whose names appear in the array passed to
+ * services()) take the following form:
+ *
+ * <pre> function myFilter($service) {
+ * // Query $service object here. Return true if the service
+ * // matches your query; false if not.
+ * }</pre>
+ *
+ * This is an example of a filter which uses a regular expression to
+ * match the content of URI tags (note that the Auth_Yadis_Service
+ * class provides a getURIs() method which you should use instead of
+ * this contrived example):
+ *
+ * <pre>
+ * function URIMatcher($service) {
+ * foreach ($service->getElements('xrd:URI') as $uri) {
+ * if (preg_match("/some_pattern/",
+ * $service->parser->content($uri))) {
+ * return true;
+ * }
+ * }
+ * return false;
+ * }</pre>
+ *
+ * The filter functions you pass will be called for each service
+ * object to determine which ones match the criteria your filters
+ * specify. The default behavior is that if a given service object
+ * matches ANY of the filters specified in the services() call, it
+ * will be returned. You can specify that a given service object will
+ * be returned ONLY if it matches ALL specified filters by changing
+ * the match mode of services():
+ *
+ * <pre> $yadis_object->services(array("filter1", "filter2"),
+ * SERVICES_YADIS_MATCH_ALL);</pre>
+ *
+ * See {@link SERVICES_YADIS_MATCH_ALL} and {@link
+ * SERVICES_YADIS_MATCH_ANY}.
+ *
+ * Services described in an XRDS should have a library which you'll
+ * probably be using. Those libraries are responsible for defining
+ * filters that can be used with the "services()" call. If you need
+ * to write your own filter, see the documentation for {@link
+ * Auth_Yadis_Service}.
+ *
+ * @package OpenID
+ */
+class Auth_Yadis_Yadis {
+
+ /**
+ * Returns an HTTP fetcher object. If the CURL extension is
+ * present, an instance of {@link Auth_Yadis_ParanoidHTTPFetcher}
+ * is returned. If not, an instance of
+ * {@link Auth_Yadis_PlainHTTPFetcher} is returned.
+ *
+ * If Auth_Yadis_CURL_OVERRIDE is defined, this method will always
+ * return a {@link Auth_Yadis_PlainHTTPFetcher}.
+ */
+ static function getHTTPFetcher($timeout = 20)
+ {
+ if (Auth_Yadis_Yadis::curlPresent() &&
+ (!defined('Auth_Yadis_CURL_OVERRIDE'))) {
+ $fetcher = new Auth_Yadis_ParanoidHTTPFetcher($timeout);
+ } else {
+ $fetcher = new Auth_Yadis_PlainHTTPFetcher($timeout);
+ }
+ return $fetcher;
+ }
+
+ static function curlPresent()
+ {
+ return function_exists('curl_init');
+ }
+
+ /**
+ * @access private
+ */
+ static function _getHeader($header_list, $names)
+ {
+ foreach ($header_list as $name => $value) {
+ foreach ($names as $n) {
+ if (strtolower($name) == strtolower($n)) {
+ return $value;
+ }
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * @access private
+ */
+ static function _getContentType($content_type_header)
+ {
+ if ($content_type_header) {
+ $parts = explode(";", $content_type_header);
+ return strtolower($parts[0]);
+ }
+ }
+
+ /**
+ * This should be called statically and will build a Yadis
+ * instance if the discovery process succeeds. This implements
+ * Yadis discovery as specified in the Yadis specification.
+ *
+ * @param string $uri The URI on which to perform Yadis discovery.
+ *
+ * @param array $http_response An array reference where the HTTP
+ * response object will be stored (see {@link
+ * Auth_Yadis_HTTPResponse}.
+ *
+ * @param Auth_Yadis_HTTPFetcher $fetcher An instance of a
+ * Auth_Yadis_HTTPFetcher subclass.
+ *
+ * @param array $extra_ns_map An array which maps namespace names
+ * to namespace URIs to be used when parsing the Yadis XRDS
+ * document.
+ *
+ * @param integer $timeout An optional fetcher timeout, in seconds.
+ *
+ * @return mixed $obj Either null or an instance of
+ * Auth_Yadis_Yadis, depending on whether the discovery
+ * succeeded.
+ */
+ static function discover($uri, $fetcher,
+ $extra_ns_map = null, $timeout = 20)
+ {
+ $result = new Auth_Yadis_DiscoveryResult($uri);
+
+ $request_uri = $uri;
+ $headers = array("Accept: " . Auth_Yadis_CONTENT_TYPE .
+ ', text/html; q=0.3, application/xhtml+xml; q=0.5');
+
+ if ($fetcher === null) {
+ $fetcher = Auth_Yadis_Yadis::getHTTPFetcher($timeout);
+ }
+
+ $response = $fetcher->get($uri, $headers);
+
+ if (!$response || ($response->status != 200 and
+ $response->status != 206)) {
+ $result->fail();
+ return $result;
+ }
+
+ $result->normalized_uri = $response->final_url;
+ $result->content_type = Auth_Yadis_Yadis::_getHeader(
+ $response->headers,
+ array('content-type'));
+
+ if ($result->content_type &&
+ (Auth_Yadis_Yadis::_getContentType($result->content_type) ==
+ Auth_Yadis_CONTENT_TYPE)) {
+ $result->xrds_uri = $result->normalized_uri;
+ } else {
+ $yadis_location = Auth_Yadis_Yadis::_getHeader(
+ $response->headers,
+ array(Auth_Yadis_HEADER_NAME));
+
+ if (!$yadis_location) {
+ $parser = new Auth_Yadis_ParseHTML();
+ $yadis_location = $parser->getHTTPEquiv($response->body);
+ }
+
+ if ($yadis_location) {
+ $result->xrds_uri = $yadis_location;
+
+ $response = $fetcher->get($yadis_location);
+
+ if ((!$response) || ($response->status != 200 and
+ $response->status != 206)) {
+ $result->fail();
+ return $result;
+ }
+
+ $result->content_type = Auth_Yadis_Yadis::_getHeader(
+ $response->headers,
+ array('content-type'));
+ }
+ }
+
+ $result->response_text = $response->body;
+ return $result;
+ }
+}
+
+
+