diff --git a/.travis.yml b/.travis.yml index 7cd984b..ac3f6aa 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,16 +5,16 @@ php: - 5.5 - 5.6 - hhvm - - hhvm-nightly matrix: allow_failures: - php: hhvm - - php: hhvm-nightly branches: only: - master + - 2.0 + - 1.9 services: - memcache @@ -22,24 +22,18 @@ services: - redis install: + - composer self-update - composer install - - pecl install uopz before_script: - - echo "extension = memcache.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - - echo "extension = memcached.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - - echo "extension = redis.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - - echo -e "zend_$(cat ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini)" > ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - - echo "zend_extension = /home/travis/.phpenv/versions/$(php -r 'echo phpversion();')/lib/php/extensions/no-debug-zts-20100525/uopz.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - - echo "[uopz]" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini - - echo "uopz.overloads=1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini + - ./tests/travis.sh - mysql -e "create database IF NOT EXISTS test;" -u root - mysql test < tests/schema.sql -u root - mkdir -p build/logs - phpenv rehash script: - - phpunit --stderr --colors --coverage-clover /home/travis/build/joshtronic/pickles/build/logs/clover.xml --bootstrap ./tests/bootstrap.php ./tests + - phpunit --coverage-clover /home/travis/build/joshtronic/pickles/build/logs/clover.xml after_success: - php vendor/bin/coveralls --config ../.coveralls.yml -v diff --git a/README.md b/README.md index f61f69c..6bf603c 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,28 @@ -# PICKLES [![Build Status](https://travis-ci.org/joshtronic/pickles.png?branch=master)](https://travis-ci.org/joshtronic/pickles) [![Coverage Status](https://coveralls.io/repos/joshtronic/pickles/badge.png)](https://coveralls.io/r/joshtronic/pickles) [![Dependency Status](https://www.versioneye.com/user/projects/52d1bc1eec13751bde00002a/badge.png)](https://www.versioneye.com/user/projects/52d1bc1eec13751bde00002a) +# Pickles -PICKLES (PHP Interface Collection of Killer Libraries to Enhance Stuff) is an -open source framework for rapid PHP development. PICKLES aims to be an “API -First” system for building APIs as well as AJAX/AJAJ-centric web applications. +[![License](http://img.shields.io/packagist/l/joshtronic/pickles.svg?style=flat)][packagist] +[![Build](http://img.shields.io/travis/joshtronic/pickles.svg?style=flat)][travis] +[![Coverage](http://img.shields.io/coveralls/joshtronic/pickles.svg?style=flat)][coveralls] +[![Downloads](http://img.shields.io/packagist/dt/joshtronic/pickles.svg?style=flat)][packagist] -## Requirements - -### Required Software - -* Web server of your choice (nginx is highly recommended but Apache with - `mod_rewrite` will suffice) -* PHP 5.4+ - -Please note that PICKLES development is focused on the most recent stable -version of PHP (currently 5.5) but will maintain backwards compatibility with -the previous stable version. It may not be immediate, but when PHP 5.6 is -released compatibility for PHP 5.4 will be dropped in favor of modern -niceties. - -For anyone stuck using PHP 5.3 is welcome to use [PICKLES v13.12.x][v13.12] -which at this time is still receiving bug fixes but will not be seeing any new -development by myself. Pull requests are welcome. - -My rant about outdated server stacks can be found [on my blog][StackPost] - -### Optional Software - -* MySQL server with the `PDO_MYSQL` driver -* PostgreSQL server with the `PDO_PGSQL` driver -* SQLite 3 with the `PDO_SQLITE` driver -* Memcached server with the `Memcache` module -* `composer` if you want to compile LESS, SCSS or JS also necessary if you - want to use AYAH integration or run the test suite -* [UOPZ][UPOZ] if you want to be able to run the test suite - -## Installation - -Installation is quite simple as there is no installer to run, and all server -configuration options can be set in your index.php for your site. - -1. [Download the PICKLES source][MasterZip] (or clone the repository) -2. Place the code anywhere you’d like (that’s at least 2 directories up from - the root of your website). I recommend using `/usr/share/pickles[-vVERSION]` -3. Run `composer update` -4. A site already built in PICKLES can be found [here][HolidayAPI] - -## TODO - -* Bring the project's Wiki up to date -* Build an actual boilerplate site that would be included in this project +Pickles f/k/a PICKLES (PHP Interface Collection of Killer Libraries to Enhance +Stuff) is an open source framework for the rapid development of RESTful +services. The intention of this framework is to allow developers to a means to +develop service-oriented backend systems that are completely decoupled from the +front end components. Thus allowing the freedom to build the front end +implementation(s) using whichever tools they choose, be it Ember.js, Angular.js +or some cool new system I’ve yet to hear of. ## Thanks Special thanks to [Geoff Oliver][GeoffOliver] for being a long time user and -contributor of PICKLES and to [Dean Jones][DeanJones] for coming up with the -PICKLES acronym. +contributor, [Justin Davis][JustinDavis] for romanticizing the v2 reimagining +and [Dean Jones][DeanJones] for helping to come up with the original PICKLES v1 +acronym. - [DeanJones]: https://github.com/deanproxy - [GeoffOliver]: https://github.com/geoffoliver - [HolidayAPI]: https://github.com/gravityblvd/tools.gravityblvd.com - [MasterZip]: https://github.com/joshtronic/pickles/archive/master.zip - [StackPost]: http://joshtronic.com/2014/01/13/your-stack-is-outdated/#.UuVzI3n0A18 - [UPOZ]: https://github.com/krakjoe/uopz - [v13.12]: https://github.com/joshtronic/pickles/tree/13.12 +[coveralls]: https://coveralls.io/r/joshtronic/pickles +[packagist]: https://packagist.org/packages/joshtronic/pickles +[travis]: http://travis-ci.org/joshtronic/pickles +[DeanJones]: https://github.com/deanproxy +[GeoffOliver]: https://github.com/geoffoliver +[JustinDavis]: http://justindavis.co diff --git a/composer.json b/composer.json index 1e28c79..24f7380 100644 --- a/composer.json +++ b/composer.json @@ -1,29 +1,37 @@ { - "name": "joshtronic/pickles", - "description": "PHP Interface Collection of Killer Libraries to Enhance Stuff", - "type": "library", - "keywords": ["pickles", "framework", "rapid", "development", "mvc"], - "homepage": "https://github.com/joshtronic/pickles", - "license": "MIT", + "name": "joshtronic/pickles", + "description": "Pickles is a PHP framework for building kick-ass services", + "type": "library", + "keywords": ["framework", "api", "soa", "oauth"], + "homepage": "http://picklesphp.com", + "license": "MIT", "authors": [ { - "name": "Josh Sherman", - "email": "josh@gravityblvd.com", + "name": "Josh Sherman", + "email": "josh@gravityblvd.com", "homepage": "http://joshtronic.com" } ], - "repositories": [{ - "type": "vcs", - "url": "https://github.com/joshtronic/php-ayah" - }], + "support": { + "issues": "https://github.com/joshtronic/pickles/issues", + "source": "https://github.com/joshtronic/pickles" + }, + "minimum-stability" : "dev", "require-dev": { - "mikey179/vfsStream": "1.3.0", + "phpunit/phpunit": "dev-master", "satooshi/php-coveralls": "dev-master" }, "require": { - "php": ">=5.4" + "php": ">=5.4", + "league/oauth2-server": "4.0.x-dev" + }, + "suggest": { + "mongodb/mongo-php-driver": "Required to use the Mongo storage engine", + "predis/predis": "Required to use the Redis storage engine" }, "autoload": { - "classmap": ["src/"] + "psr-4": { + "Pickles\\" : "src/" + } } } diff --git a/composer.lock b/composer.lock index 7922e64..dfb8338 100644 --- a/composer.lock +++ b/composer.lock @@ -1,23 +1,250 @@ { "_readme": [ "This file locks the dependencies of your project to a known state", - "Read more about it at http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file" + "Read more about it at http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", + "This file is @generated automatically" ], - "hash": "072c3455e32a8fe13eedc5d6ae22867b", - "packages": [], - "packages-dev": [ + "hash": "65e330b4eb2873d61093fc36aa624d0f", + "packages": [ { - "name": "guzzle/guzzle", - "version": "v3.9.2", + "name": "league/event", + "version": "1.0.0", "source": { "type": "git", - "url": "https://github.com/guzzle/guzzle3.git", - "reference": "54991459675c1a2924122afbb0e5609ade581155" + "url": "https://github.com/thephpleague/event.git", + "reference": "06adb7ce55b93346be43a3ba677ac613bbf288a2" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/guzzle/guzzle3/zipball/54991459675c1a2924122afbb0e5609ade581155", - "reference": "54991459675c1a2924122afbb0e5609ade581155", + "url": "https://api.github.com/repos/thephpleague/event/zipball/06adb7ce55b93346be43a3ba677ac613bbf288a2", + "reference": "06adb7ce55b93346be43a3ba677ac613bbf288a2", + "shasum": "" + }, + "require": { + "php": ">=5.4.0" + }, + "require-dev": { + "henrikbjorn/phpspec-code-coverage": "1.0.*@dev", + "phpspec/phpspec": "2.0.*@dev" + }, + "type": "library", + "autoload": { + "psr-4": { + "League\\Event\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Frank de Jonge", + "email": "info@frenky.net" + } + ], + "description": "Event package", + "keywords": [ + "emitter", + "event", + "listener" + ], + "time": "2014-09-09 14:40:43" + }, + { + "name": "league/oauth2-server", + "version": "dev-develop", + "source": { + "type": "git", + "url": "https://github.com/thephpleague/oauth2-server.git", + "reference": "6333a975f8fb51111b447a7e85806e4519fb52b9" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/thephpleague/oauth2-server/zipball/6333a975f8fb51111b447a7e85806e4519fb52b9", + "reference": "6333a975f8fb51111b447a7e85806e4519fb52b9", + "shasum": "" + }, + "require": { + "league/event": "1.0.*", + "php": ">=5.4.0", + "symfony/http-foundation": "~2.1" + }, + "replace": { + "league/oauth2server": "*", + "lncd/oauth2": "*" + }, + "require-dev": { + "alexbilbie/fizzfuzz": "dev-develop", + "codeception/codeception": "2.0.*", + "league/phpunit-coverage-listener": "~1.0", + "mockery/mockery": "~0.9", + "phpunit/phpunit": "~4.0", + "squizlabs/php_codesniffer": "~1.5" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-develop": "4.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "League\\OAuth2\\Server\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Alex Bilbie", + "email": "hello@alexbilbie.com", + "homepage": "http://www.alexbilbie.com", + "role": "Developer" + } + ], + "description": "A lightweight and powerful OAuth 2.0 authorization and resource server library with support for all the core specification grants. This library will allow you to secure your API with OAuth and allow your applications users to approve apps that want to access their data from your API.", + "homepage": "http://oauth2.thephpleague.com/", + "keywords": [ + "Authentication", + "api", + "auth", + "authorisation", + "authorization", + "oauth", + "oauth 2", + "oauth 2.0", + "oauth2", + "protect", + "resource", + "secure", + "server" + ], + "time": "2014-10-03 13:42:01" + }, + { + "name": "symfony/http-foundation", + "version": "dev-master", + "target-dir": "Symfony/Component/HttpFoundation", + "source": { + "type": "git", + "url": "https://github.com/symfony/HttpFoundation.git", + "reference": "c24942a7ec2d8409d1f60d02c4460ca8317e885a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/HttpFoundation/zipball/c24942a7ec2d8409d1f60d02c4460ca8317e885a", + "reference": "c24942a7ec2d8409d1f60d02c4460ca8317e885a", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "symfony/expression-language": "~2.4" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.6-dev" + } + }, + "autoload": { + "psr-0": { + "Symfony\\Component\\HttpFoundation\\": "" + }, + "classmap": [ + "Symfony/Component/HttpFoundation/Resources/stubs" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Symfony Community", + "homepage": "http://symfony.com/contributors" + }, + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + } + ], + "description": "Symfony HttpFoundation Component", + "homepage": "http://symfony.com", + "time": "2014-10-07 14:06:18" + } + ], + "packages-dev": [ + { + "name": "doctrine/instantiator", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/doctrine/instantiator.git", + "reference": "f976e5de371104877ebc89bd8fecb0019ed9c119" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/doctrine/instantiator/zipball/f976e5de371104877ebc89bd8fecb0019ed9c119", + "reference": "f976e5de371104877ebc89bd8fecb0019ed9c119", + "shasum": "" + }, + "require": { + "php": ">=5.3,<8.0-DEV" + }, + "require-dev": { + "athletic/athletic": "~0.1.8", + "ext-pdo": "*", + "ext-phar": "*", + "phpunit/phpunit": "~4.0", + "squizlabs/php_codesniffer": "2.0.*@ALPHA" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-0": { + "Doctrine\\Instantiator\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Marco Pivetta", + "email": "ocramius@gmail.com", + "homepage": "http://ocramius.github.com/" + } + ], + "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors", + "homepage": "https://github.com/doctrine/instantiator", + "keywords": [ + "constructor", + "instantiate" + ], + "time": "2014-10-13 12:58:55" + }, + { + "name": "guzzle/guzzle", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/guzzle/guzzle3.git", + "reference": "3c0ca2255751631f1dd64eb16bbe3b9440258297" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/guzzle/guzzle3/zipball/3c0ca2255751631f1dd64eb16bbe3b9440258297", + "reference": "3c0ca2255751631f1dd64eb16bbe3b9440258297", "shasum": "" }, "require": { @@ -96,45 +323,377 @@ "rest", "web service" ], - "time": "2014-08-11 04:32:36" + "time": "2014-10-15 19:36:56" }, { - "name": "mikey179/vfsStream", - "version": "v1.3.0", + "name": "phpunit/php-code-coverage", + "version": "dev-master", "source": { "type": "git", - "url": "https://github.com/mikey179/vfsStream.git", - "reference": "8571f349567e02af1b7efc0fc4e3a4a1c98e664e" + "url": "https://github.com/sebastianbergmann/php-code-coverage.git", + "reference": "28d21b57c189cb72829056353de603c4d4da55a0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/mikey179/vfsStream/zipball/8571f349567e02af1b7efc0fc4e3a4a1c98e664e", - "reference": "8571f349567e02af1b7efc0fc4e3a4a1c98e664e", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/28d21b57c189cb72829056353de603c4d4da55a0", + "reference": "28d21b57c189cb72829056353de603c4d4da55a0", "shasum": "" }, "require": { - "php": ">=5.3.0" + "php": ">=5.3.3", + "phpunit/php-file-iterator": "~1.3", + "phpunit/php-text-template": "~1.2", + "phpunit/php-token-stream": "~1.3", + "sebastian/environment": "~1.0", + "sebastian/version": "~1.0" }, "require-dev": { - "phpunit/phpunit": "~4.1" + "ext-xdebug": ">=2.1.4", + "phpunit/phpunit": "dev-master" + }, + "suggest": { + "ext-dom": "*", + "ext-xdebug": ">=2.2.1", + "ext-xmlwriter": "*" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.3.x-dev" + "dev-master": "3.0.x-dev" } }, "autoload": { - "psr-0": { - "org\\bovigo\\vfs\\": "src/main/php" - } + "classmap": [ + "src/" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD" + "BSD-3-Clause" ], - "homepage": "http://vfs.bovigo.org/", - "time": "2014-07-21 20:15:54" + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sb@sebastian-bergmann.de", + "role": "lead" + } + ], + "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.", + "homepage": "https://github.com/sebastianbergmann/php-code-coverage", + "keywords": [ + "coverage", + "testing", + "xunit" + ], + "time": "2014-10-05 10:46:54" + }, + { + "name": "phpunit/php-file-iterator", + "version": "1.3.4", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-file-iterator.git", + "reference": "acd690379117b042d1c8af1fafd61bde001bf6bb" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/acd690379117b042d1c8af1fafd61bde001bf6bb", + "reference": "acd690379117b042d1c8af1fafd61bde001bf6bb", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "type": "library", + "autoload": { + "classmap": [ + "File/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "include-path": [ + "" + ], + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sb@sebastian-bergmann.de", + "role": "lead" + } + ], + "description": "FilterIterator implementation that filters files based on a list of suffixes.", + "homepage": "https://github.com/sebastianbergmann/php-file-iterator/", + "keywords": [ + "filesystem", + "iterator" + ], + "time": "2013-10-10 15:34:57" + }, + { + "name": "phpunit/php-text-template", + "version": "1.2.0", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-text-template.git", + "reference": "206dfefc0ffe9cebf65c413e3d0e809c82fbf00a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/206dfefc0ffe9cebf65c413e3d0e809c82fbf00a", + "reference": "206dfefc0ffe9cebf65c413e3d0e809c82fbf00a", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "type": "library", + "autoload": { + "classmap": [ + "Text/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "include-path": [ + "" + ], + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sb@sebastian-bergmann.de", + "role": "lead" + } + ], + "description": "Simple template engine.", + "homepage": "https://github.com/sebastianbergmann/php-text-template/", + "keywords": [ + "template" + ], + "time": "2014-01-30 17:20:04" + }, + { + "name": "phpunit/php-timer", + "version": "1.0.5", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-timer.git", + "reference": "19689d4354b295ee3d8c54b4f42c3efb69cbc17c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/19689d4354b295ee3d8c54b4f42c3efb69cbc17c", + "reference": "19689d4354b295ee3d8c54b4f42c3efb69cbc17c", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "type": "library", + "autoload": { + "classmap": [ + "PHP/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "include-path": [ + "" + ], + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sb@sebastian-bergmann.de", + "role": "lead" + } + ], + "description": "Utility class for timing", + "homepage": "https://github.com/sebastianbergmann/php-timer/", + "keywords": [ + "timer" + ], + "time": "2013-08-02 07:42:54" + }, + { + "name": "phpunit/php-token-stream", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-token-stream.git", + "reference": "f8d5d08c56de5cfd592b3340424a81733259a876" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/f8d5d08c56de5cfd592b3340424a81733259a876", + "reference": "f8d5d08c56de5cfd592b3340424a81733259a876", + "shasum": "" + }, + "require": { + "ext-tokenizer": "*", + "php": ">=5.3.3" + }, + "require-dev": { + "phpunit/phpunit": "~4.2" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.3-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + } + ], + "description": "Wrapper around PHP's tokenizer extension.", + "homepage": "https://github.com/sebastianbergmann/php-token-stream/", + "keywords": [ + "tokenizer" + ], + "time": "2014-08-31 06:12:13" + }, + { + "name": "phpunit/phpunit", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/phpunit.git", + "reference": "cd4014775069d7d39d20f617037c2c0f9b4bc25b" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/cd4014775069d7d39d20f617037c2c0f9b4bc25b", + "reference": "cd4014775069d7d39d20f617037c2c0f9b4bc25b", + "shasum": "" + }, + "require": { + "ext-dom": "*", + "ext-json": "*", + "ext-pcre": "*", + "ext-reflection": "*", + "ext-spl": "*", + "php": ">=5.3.3", + "phpunit/php-code-coverage": "3.0.*@dev", + "phpunit/php-file-iterator": "~1.3.1", + "phpunit/php-text-template": "~1.2", + "phpunit/php-timer": "~1.0.2", + "phpunit/phpunit-mock-objects": "2.4.*@dev", + "sebastian/comparator": "~1.0", + "sebastian/diff": "~1.1", + "sebastian/environment": "~1.1", + "sebastian/exporter": "~1.0", + "sebastian/global-state": "1.0.*@dev", + "sebastian/version": "~1.0", + "symfony/yaml": "~2.0" + }, + "suggest": { + "phpunit/php-invoker": "~1.1" + }, + "bin": [ + "phpunit" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "4.4.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "The PHP Unit Testing framework.", + "homepage": "https://phpunit.de/", + "keywords": [ + "phpunit", + "testing", + "xunit" + ], + "time": "2014-10-17 09:28:50" + }, + { + "name": "phpunit/phpunit-mock-objects", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git", + "reference": "96c5b81f9842f38fe6c73ad0020306cc4862a9e3" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/96c5b81f9842f38fe6c73ad0020306cc4862a9e3", + "reference": "96c5b81f9842f38fe6c73ad0020306cc4862a9e3", + "shasum": "" + }, + "require": { + "doctrine/instantiator": "~1.0,>=1.0.2", + "php": ">=5.3.3", + "phpunit/php-text-template": "~1.2" + }, + "require-dev": { + "phpunit/phpunit": "4.4.*@dev" + }, + "suggest": { + "ext-soap": "*" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.4.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sb@sebastian-bergmann.de", + "role": "lead" + } + ], + "description": "Mock Object library for PHPUnit", + "homepage": "https://github.com/sebastianbergmann/phpunit-mock-objects/", + "keywords": [ + "mock", + "xunit" + ], + "time": "2014-10-04 10:04:20" }, { "name": "psr/log", @@ -249,19 +808,337 @@ ], "time": "2014-07-09 10:45:38" }, + { + "name": "sebastian/comparator", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/comparator.git", + "reference": "e54a01c0da1b87db3c5a3c4c5277ddf331da4aef" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/e54a01c0da1b87db3c5a3c4c5277ddf331da4aef", + "reference": "e54a01c0da1b87db3c5a3c4c5277ddf331da4aef", + "shasum": "" + }, + "require": { + "php": ">=5.3.3", + "sebastian/diff": "~1.1", + "sebastian/exporter": "~1.0" + }, + "require-dev": { + "phpunit/phpunit": "~4.1" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + }, + { + "name": "Jeff Welch", + "email": "whatthejeff@gmail.com" + }, + { + "name": "Volker Dusch", + "email": "github@wallbash.com" + }, + { + "name": "Bernhard Schussek", + "email": "bschussek@2bepublished.at" + } + ], + "description": "Provides the functionality to compare PHP values for equality", + "homepage": "http://www.github.com/sebastianbergmann/comparator", + "keywords": [ + "comparator", + "compare", + "equality" + ], + "time": "2014-05-11 23:00:21" + }, + { + "name": "sebastian/diff", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/diff.git", + "reference": "92d423df43b160006907ea4297b916fdf00415d8" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/92d423df43b160006907ea4297b916fdf00415d8", + "reference": "92d423df43b160006907ea4297b916fdf00415d8", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "phpunit/phpunit": "~4.2" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.2-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Kore Nordmann", + "email": "mail@kore-nordmann.de" + }, + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + } + ], + "description": "Diff implementation", + "homepage": "http://www.github.com/sebastianbergmann/diff", + "keywords": [ + "diff" + ], + "time": "2014-10-19 13:19:30" + }, + { + "name": "sebastian/environment", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/environment.git", + "reference": "205fcef5998953ec69cb79bc1ea9fee1277c8714" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/205fcef5998953ec69cb79bc1ea9fee1277c8714", + "reference": "205fcef5998953ec69cb79bc1ea9fee1277c8714", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "phpunit/phpunit": "~4.3" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.1.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + } + ], + "description": "Provides functionality to handle HHVM/PHP environments", + "homepage": "http://www.github.com/sebastianbergmann/environment", + "keywords": [ + "Xdebug", + "environment", + "hhvm" + ], + "time": "2014-10-08 05:30:43" + }, + { + "name": "sebastian/exporter", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/exporter.git", + "reference": "c7d59948d6e82818e1bdff7cadb6c34710eb7dc0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/c7d59948d6e82818e1bdff7cadb6c34710eb7dc0", + "reference": "c7d59948d6e82818e1bdff7cadb6c34710eb7dc0", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "phpunit/phpunit": "~4.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Jeff Welch", + "email": "whatthejeff@gmail.com" + }, + { + "name": "Volker Dusch", + "email": "github@wallbash.com" + }, + { + "name": "Bernhard Schussek", + "email": "bschussek@2bepublished.at" + }, + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + }, + { + "name": "Adam Harvey", + "email": "aharvey@php.net" + } + ], + "description": "Provides the functionality to export PHP variables for visualization", + "homepage": "http://www.github.com/sebastianbergmann/exporter", + "keywords": [ + "export", + "exporter" + ], + "time": "2014-09-10 00:51:36" + }, + { + "name": "sebastian/global-state", + "version": "dev-master", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/global-state.git", + "reference": "231d48620efde984fd077ee92916099a3ece9a59" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/231d48620efde984fd077ee92916099a3ece9a59", + "reference": "231d48620efde984fd077ee92916099a3ece9a59", + "shasum": "" + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "phpunit/phpunit": "~4.2" + }, + "suggest": { + "ext-uopz": "*" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + } + ], + "description": "Snapshotting of global state", + "homepage": "http://www.github.com/sebastianbergmann/global-state", + "keywords": [ + "global state" + ], + "time": "2014-10-06 09:49:11" + }, + { + "name": "sebastian/version", + "version": "1.0.3", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/version.git", + "reference": "b6e1f0cf6b9e1ec409a0d3e2f2a5fb0998e36b43" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/b6e1f0cf6b9e1ec409a0d3e2f2a5fb0998e36b43", + "reference": "b6e1f0cf6b9e1ec409a0d3e2f2a5fb0998e36b43", + "shasum": "" + }, + "type": "library", + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "Library that helps with managing the version number of Git-hosted PHP projects", + "homepage": "https://github.com/sebastianbergmann/version", + "time": "2014-03-07 15:35:33" + }, { "name": "symfony/config", - "version": "v2.5.4", + "version": "dev-master", "target-dir": "Symfony/Component/Config", "source": { "type": "git", "url": "https://github.com/symfony/Config.git", - "reference": "080eabdc256c1d7a3a7cf6296271edb68eb1ab2b" + "reference": "b9f7877e02682cb081585c58baf3b9760865b98e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/Config/zipball/080eabdc256c1d7a3a7cf6296271edb68eb1ab2b", - "reference": "080eabdc256c1d7a3a7cf6296271edb68eb1ab2b", + "url": "https://api.github.com/repos/symfony/Config/zipball/b9f7877e02682cb081585c58baf3b9760865b98e", + "reference": "b9f7877e02682cb081585c58baf3b9760865b98e", "shasum": "" }, "require": { @@ -271,7 +1148,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev" + "dev-master": "2.6-dev" } }, "autoload": { @@ -295,21 +1172,21 @@ ], "description": "Symfony Config Component", "homepage": "http://symfony.com", - "time": "2014-08-31 03:22:04" + "time": "2014-09-25 18:11:49" }, { "name": "symfony/console", - "version": "v2.5.4", + "version": "dev-master", "target-dir": "Symfony/Component/Console", "source": { "type": "git", "url": "https://github.com/symfony/Console.git", - "reference": "748beed2a1e73179c3f5154d33fe6ae100c1aeb1" + "reference": "771649efa94246e63a6ab2726ba908a358bdd403" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/Console/zipball/748beed2a1e73179c3f5154d33fe6ae100c1aeb1", - "reference": "748beed2a1e73179c3f5154d33fe6ae100c1aeb1", + "url": "https://api.github.com/repos/symfony/Console/zipball/771649efa94246e63a6ab2726ba908a358bdd403", + "reference": "771649efa94246e63a6ab2726ba908a358bdd403", "shasum": "" }, "require": { @@ -317,16 +1194,18 @@ }, "require-dev": { "psr/log": "~1.0", - "symfony/event-dispatcher": "~2.1" + "symfony/event-dispatcher": "~2.1", + "symfony/process": "~2.1" }, "suggest": { "psr/log": "For using the console logger", - "symfony/event-dispatcher": "" + "symfony/event-dispatcher": "", + "symfony/process": "" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev" + "dev-master": "2.6-dev" } }, "autoload": { @@ -350,21 +1229,21 @@ ], "description": "Symfony Console Component", "homepage": "http://symfony.com", - "time": "2014-08-14 16:10:54" + "time": "2014-10-05 13:59:22" }, { "name": "symfony/event-dispatcher", - "version": "v2.5.4", + "version": "dev-master", "target-dir": "Symfony/Component/EventDispatcher", "source": { "type": "git", "url": "https://github.com/symfony/EventDispatcher.git", - "reference": "8faf5cc7e80fde74a650a36e60d32ce3c3e0457b" + "reference": "e133748fd9165e24f8e9498ef5862f8bd37004e5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/EventDispatcher/zipball/8faf5cc7e80fde74a650a36e60d32ce3c3e0457b", - "reference": "8faf5cc7e80fde74a650a36e60d32ce3c3e0457b", + "url": "https://api.github.com/repos/symfony/EventDispatcher/zipball/e133748fd9165e24f8e9498ef5862f8bd37004e5", + "reference": "e133748fd9165e24f8e9498ef5862f8bd37004e5", "shasum": "" }, "require": { @@ -373,7 +1252,8 @@ "require-dev": { "psr/log": "~1.0", "symfony/config": "~2.0", - "symfony/dependency-injection": "~2.0", + "symfony/dependency-injection": "~2.6", + "symfony/expression-language": "~2.6", "symfony/stopwatch": "~2.2" }, "suggest": { @@ -383,7 +1263,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev" + "dev-master": "2.6-dev" } }, "autoload": { @@ -407,21 +1287,21 @@ ], "description": "Symfony EventDispatcher Component", "homepage": "http://symfony.com", - "time": "2014-07-28 13:20:46" + "time": "2014-10-04 06:08:58" }, { "name": "symfony/filesystem", - "version": "v2.5.4", + "version": "dev-master", "target-dir": "Symfony/Component/Filesystem", "source": { "type": "git", "url": "https://github.com/symfony/Filesystem.git", - "reference": "a765efd199e02ff4001c115c318e219030be9364" + "reference": "7d97789ea01c3c76ecaa59b954d162777033cbd4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/Filesystem/zipball/a765efd199e02ff4001c115c318e219030be9364", - "reference": "a765efd199e02ff4001c115c318e219030be9364", + "url": "https://api.github.com/repos/symfony/Filesystem/zipball/7d97789ea01c3c76ecaa59b954d162777033cbd4", + "reference": "7d97789ea01c3c76ecaa59b954d162777033cbd4", "shasum": "" }, "require": { @@ -430,7 +1310,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev" + "dev-master": "2.6-dev" } }, "autoload": { @@ -454,21 +1334,21 @@ ], "description": "Symfony Filesystem Component", "homepage": "http://symfony.com", - "time": "2014-09-03 09:00:14" + "time": "2014-09-22 15:54:44" }, { "name": "symfony/stopwatch", - "version": "v2.5.4", + "version": "dev-master", "target-dir": "Symfony/Component/Stopwatch", "source": { "type": "git", "url": "https://github.com/symfony/Stopwatch.git", - "reference": "22ab4f76cdeefd38b00022a6be5709190a2fd046" + "reference": "f7cca9c342ce395d2aa17383d0f9a409d81ca585" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/Stopwatch/zipball/22ab4f76cdeefd38b00022a6be5709190a2fd046", - "reference": "22ab4f76cdeefd38b00022a6be5709190a2fd046", + "url": "https://api.github.com/repos/symfony/Stopwatch/zipball/f7cca9c342ce395d2aa17383d0f9a409d81ca585", + "reference": "f7cca9c342ce395d2aa17383d0f9a409d81ca585", "shasum": "" }, "require": { @@ -477,7 +1357,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev" + "dev-master": "2.6-dev" } }, "autoload": { @@ -501,21 +1381,21 @@ ], "description": "Symfony Stopwatch Component", "homepage": "http://symfony.com", - "time": "2014-08-14 16:10:54" + "time": "2014-09-22 11:59:59" }, { "name": "symfony/yaml", - "version": "v2.5.4", + "version": "dev-master", "target-dir": "Symfony/Component/Yaml", "source": { "type": "git", "url": "https://github.com/symfony/Yaml.git", - "reference": "01a7695bcfb013d0a15c6757e15aae120342986f" + "reference": "499f7d7aa96747ad97940089bd7a1fb24ad8182a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/Yaml/zipball/01a7695bcfb013d0a15c6757e15aae120342986f", - "reference": "01a7695bcfb013d0a15c6757e15aae120342986f", + "url": "https://api.github.com/repos/symfony/Yaml/zipball/499f7d7aa96747ad97940089bd7a1fb24ad8182a", + "reference": "499f7d7aa96747ad97940089bd7a1fb24ad8182a", "shasum": "" }, "require": { @@ -524,7 +1404,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "2.5-dev" + "dev-master": "2.6-dev" } }, "autoload": { @@ -548,14 +1428,17 @@ ], "description": "Symfony Yaml Component", "homepage": "http://symfony.com", - "time": "2014-08-31 03:22:04" + "time": "2014-10-05 13:53:50" } ], "aliases": [], - "minimum-stability": "stable", + "minimum-stability": "dev", "stability-flags": { + "league/oauth2-server": 20, + "phpunit/phpunit": 20, "satooshi/php-coveralls": 20 }, + "prefer-stable": false, "platform": { "php": ">=5.4" }, diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..2d7ea10 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,14 @@ + + + + + ./tests/Pickles + + + diff --git a/sql/oauth2.sql b/sql/oauth2.sql new file mode 100644 index 0000000..5c4fbc1 --- /dev/null +++ b/sql/oauth2.sql @@ -0,0 +1,129 @@ +CREATE TABLE `oauth_clients` ( + `id` CHAR(40) NOT NULL, + `secret` CHAR(40) NOT NULL, + `name` VARCHAR(255) NOT NULL, + `auto_approve` TINYINT(1) NOT NULL DEFAULT '0', + PRIMARY KEY (`id`), + UNIQUE KEY `u_oacl_clse_clid` (`secret`,`id`) +) ENGINE=INNODB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_endpoints` ( + `id` int(10) unsigned NOT NULL AUTO_INCREMENT, + `client_id` char(40) NOT NULL, + `redirect_uri` varchar(255) NOT NULL, + PRIMARY KEY (`id`), + KEY `i_oaclen_clid` (`client_id`), + CONSTRAINT `f_oaclen_clid` + FOREIGN KEY (`client_id`) + REFERENCES `oauth_clients` (`id`) + ON DELETE CASCADE ON UPDATE CASCADE +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_sessions` ( + `id` int(10) unsigned NOT NULL AUTO_INCREMENT, + `client_id` char(40) NOT NULL, + `owner_type` enum('user','client') NOT NULL DEFAULT 'user', + `owner_id` varchar(255) NOT NULL, + PRIMARY KEY (`id`), + KEY `i_uase_clid_owty_owid` (`client_id`,`owner_type`,`owner_id`), + CONSTRAINT `f_oase_clid` + FOREIGN KEY (`client_id`) + REFERENCES `oauth_clients` (`id`) + ON DELETE CASCADE ON UPDATE CASCADE +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_access_tokens` ( + `id` int(10) unsigned NOT NULL AUTO_INCREMENT, + `session_id` int(10) unsigned NOT NULL, + `access_token` char(40) NOT NULL, + `expires_at` int(10) unsigned NOT NULL, + PRIMARY KEY (`id`), + UNIQUE KEY `u_oaseacto_acto_seid` (`access_token`,`session_id`), + KEY `f_oaseto_seid` (`session_id`), + CONSTRAINT `f_oaseto_seid` + FOREIGN KEY (`session_id`) + REFERENCES `oauth_sessions` (`id`) + ON DELETE CASCADE ON UPDATE NO ACTION +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_authorization_codes` ( + `id` int(10) unsigned NOT NULL AUTO_INCREMENT, + `session_id` int(10) unsigned NOT NULL, + `authorization_code` char(40) NOT NULL, + `expires_at` int(10) unsigned NOT NULL, + PRIMARY KEY (`id`), + KEY `session_id` (`session_id`), + CONSTRAINT `oauth_authorization_codes_ibfk_1` + FOREIGN KEY (`session_id`) + REFERENCES `oauth_sessions` (`id`) + ON DELETE CASCADE +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_redirect_uris` ( + `session_id` int(10) unsigned NOT NULL, + `redirect_uri` varchar(255) NOT NULL, + PRIMARY KEY (`session_id`), + CONSTRAINT `f_oasere_seid` + FOREIGN KEY (`session_id`) + REFERENCES `oauth_sessions` (`id`) + ON DELETE CASCADE ON UPDATE NO ACTION +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_refresh_tokens` ( + `access_token_id` int(10) unsigned NOT NULL, + `refresh_token` char(40) NOT NULL, + `expires_at` int(10) unsigned NOT NULL, + `client_id` char(40) NOT NULL, + PRIMARY KEY (`access_token_id`), + KEY `client_id` (`client_id`), + CONSTRAINT `oauth_refresh_tokens_ibfk_1` + FOREIGN KEY (`client_id`) + REFERENCES `oauth_clients` (`id`) + ON DELETE CASCADE, + CONSTRAINT `f_oasetore_setoid` + FOREIGN KEY (`access_token_id`) + REFERENCES `oauth_access_tokens` (`id`) + ON DELETE CASCADE ON UPDATE NO ACTION +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_scopes` ( + `id` smallint(5) unsigned NOT NULL AUTO_INCREMENT, + `scope` varchar(255) NOT NULL, + `name` varchar(255) NOT NULL, + `description` varchar(255) DEFAULT NULL, + PRIMARY KEY (`id`), + UNIQUE KEY `u_oasc_sc` (`scope`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_access_token_scopes` ( + `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, + `access_token_id` int(10) unsigned DEFAULT NULL, + `scope_id` smallint(5) unsigned NOT NULL, + PRIMARY KEY (`id`), + UNIQUE KEY `u_setosc_setoid_scid` (`access_token_id`,`scope_id`), + KEY `f_oasetosc_scid` (`scope_id`), + CONSTRAINT `f_oasetosc_scid` + FOREIGN KEY (`scope_id`) + REFERENCES `oauth_scopes` (`id`) + ON DELETE CASCADE ON UPDATE NO ACTION, + CONSTRAINT `f_oasetosc_setoid` + FOREIGN KEY (`access_token_id`) + REFERENCES `oauth_access_tokens` (`id`) + ON DELETE CASCADE ON UPDATE NO ACTION +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + +CREATE TABLE `oauth_authorization_code_scopes` ( + `authorization_code_id` int(10) unsigned NOT NULL, + `scope_id` smallint(5) unsigned NOT NULL, + KEY `authorization_code_id` (`authorization_code_id`), + KEY `scope_id` (`scope_id`), + CONSTRAINT `oauth_authorization_code_scopes_ibfk_2` + FOREIGN KEY (`scope_id`) + REFERENCES `oauth_scopes` (`id`) + ON DELETE CASCADE, + CONSTRAINT `oauth_authorization_code_scopes_ibfk_1` + FOREIGN KEY (`authorization_code_id`) + REFERENCES `oauth_authorization_codes` (`id`) + ON DELETE CASCADE +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_unicode_ci; + diff --git a/src/Config.php b/src/Config.php new file mode 100644 index 0000000..1ef241e --- /dev/null +++ b/src/Config.php @@ -0,0 +1,212 @@ +)'); + } + + // Loops through the environments and looks for a match + foreach ($config['environments'] as $name => $hosts) + { + if (!is_array($hosts)) + { + $hosts = [$hosts]; + } + + // Tries to determine the environment name + foreach ($hosts as $host) + { + if ($cli) + { + // Checks the first argument on the command line + if ($_SERVER['argv'][1] == $name) + { + $environment = $name; + break; + } + } + else + { + // Exact match + if ((preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $host) + && $_SERVER['SERVER_ADDR'] == $host) + || (isset($_SERVER['HTTP_HOST']) && $_SERVER['HTTP_HOST'] == $host)) + { + $environment = $name; + break; + } + // Fuzzy match + elseif (substr($host, 0, 1) == '/' + && (preg_match($host, $_SERVER['SERVER_NAME'], $matches) > 0 + || preg_match($host, $_SERVER['HTTP_HOST'], $matches) > 0)) + { + $environments[$name] = $matches[0]; + $environment = $name; + $config['environments'][$name] = $matches[0]; + break; + } + } + } + } + + if (!$environment) + { + throw new \Exception('Unable to determine the environment.'); + } + + // Flattens the array based on the environment + $config = $this->flatten($environment, $config); + + // Disables display errors in production + if ($environment == 'production') + { + ini_set('display_errors', false); + } + + // Assigns the environment + $config['environment'] = $environment; + + // Defaults expected Pickles variables to false + foreach (['auth', 'cache', 'profiler'] as $variable) + { + if (!isset($config[$variable])) + { + $config[$variable] = false; + } + } + + // Assigns the config variables to the object + foreach ($config as $variable => $value) + { + $this[$variable] = $value; + } + } + catch (\Exception $e) + { + throw $e; + } + } + + /** + * Flatten + * + * Flattens the configuration array around the specified environment. + * + * @param string $environment selected environment + * @param array $array configuration error to flatten + * @return array flattened configuration array + */ + private function flatten($environment, $array) + { + if (is_array($array)) + { + foreach ($array as $key => $value) + { + if (is_array($value)) + { + if (isset($value[$environment])) + { + $value = $value[$environment]; + } + else + { + $value = $this->flatten($environment, $value); + } + } + + $array[$key] = $value; + } + } + + return $array; + } + + /** + * Get instance of the object + * + * Let's the parent class do all the work + * + * @static + * @param string $file name of config to load + * @return object self::$_instance instance of the Config class + */ + public static function getInstance($file = false) + { + if (!self::$_instance || $file) + { + self::$_instance = new Config($file); + } + + return self::$_instance; + } +} + diff --git a/src/Mongo.php b/src/Mongo.php new file mode 100644 index 0000000..2ffcc50 --- /dev/null +++ b/src/Mongo.php @@ -0,0 +1,50 @@ +selectDB($mongo['database']); + + // Caches the instance for possible reuse later + self::$instances['Mongo'] = $instance; + } + + // Returns the instance + return self::$instances['Mongo']; + } +} + diff --git a/src/OAuth2/AccessTokenStorage.php b/src/OAuth2/AccessTokenStorage.php new file mode 100644 index 0000000..04d8dc0 --- /dev/null +++ b/src/OAuth2/AccessTokenStorage.php @@ -0,0 +1,84 @@ += ?;'; + + $results = $this->db->fetch($sql, [$token, time()]); + + if (count($results) === 1) + { + return (new AccessTokenEntity($this->server)) + ->setId($results[0]['access_token']) + ->setExpireTime($results[0]['expires_at']); + } + + return null; + } + + public function getScopes(AbstractTokenEntity $token) + { + $sql = 'SELECT oauth_scopes.id, oauth_scopes.description' + . ' FROM oauth_access_token_scopes' + . ' INNER JOIN oauth_scopes' + . ' ON oauth_access_token_scopes.scope_id = oauth_scopes.id' + . ' WHERE oauth_access_token_scopes.access_token_id = ?;'; + + $results = $this->db->fetch($sql, [$token->getId()]); + $response = []; + + if (count($results) > 0) + { + foreach ($results as $row) + { + $response[] = (new ScopeEntity($this->server))->hydrate([ + 'id' => $row['id'], + 'description' => $row['description'] + ]); + } + } + + return $response; + } + + public function create($token, $expiration, $session_id) + { + $sql = 'INSERT INTO oauth_access_tokens' + . ' (access_token, session_id, expires_at)' + . ' VALUES' + . ' (?, ?, ?);'; + + $this->db->execute($sql, [$token, $session_id, $expiration]); + } + + public function associateScope(AbstractTokenEntity $token, ScopeEntity $scope) + { + $sql = 'INSERT INTO oauth_access_token_scopes' + . ' (access_token, scope)' + . ' VALUES' + . ' (?, ?);'; + + $this->db->execute($sql, [$token->getId(), $scope->getId()]); + } + + public function delete(AbstractTokenEntity $token) + { + $sql = 'DELETE FROM oauth_access_token_scopes' + . ' WHERE access_token = ?;'; + + $this->db->execute($sql, [$token->getId()]); + } +} + diff --git a/src/OAuth2/ClientStorage.php b/src/OAuth2/ClientStorage.php new file mode 100644 index 0000000..1a32583 --- /dev/null +++ b/src/OAuth2/ClientStorage.php @@ -0,0 +1,81 @@ +db->fetch($sql, $parameters); + + if (count($results) === 1) + { + $client = new ClientEntity($this->server); + + $client->hydrate([ + 'id' => $results[0]['id'], + 'name' => $results[0]['name'] + ]); + + return $client; + } + + return null; + } + + public function getBySession(SessionEntity $session) + { + $sql = 'SELECT oauth_clients.id, oauth_clients.name' + . ' FROM oauth_clients' + . ' INNER JOIN oauth_sessions' + . ' ON oauth_clients.id = oauth_sessions.client_id' + . ' WHERE oauth_sessions.id = ?'; + + $results = $this->db->fetch($sql, [$session->getId()]); + + if (count($results) === 1) + { + $client = new ClientEntity($this->server); + + $client->hydrate([ + 'id' => $results[0]['id'], + 'name' => $results[0]['name'] + ]); + + return $client; + } + + return null; + } +} + diff --git a/src/OAuth2/RefreshTokenStorage.php b/src/OAuth2/RefreshTokenStorage.php new file mode 100644 index 0000000..bceea31 --- /dev/null +++ b/src/OAuth2/RefreshTokenStorage.php @@ -0,0 +1,56 @@ += ?;'; + + $results = $this->db->fetch($sql, [$token, time()]); + + if (count($results) === 1) + { + return (new RefreshTokenEntity($this->server)) + ->setId($results[0]['refresh_token']) + ->setExpireTime($results[0]['expires_at']) + ->setAccessTokenId($results[0]['access_token_id']); + } + + return null; + } + + public function create($token, $expiration, $access_token) + { + $sql = 'SELECT id FROM oauth_access_tokens WHERE access_token = ?;'; + $results = $this->db->fetch($sql, [$access_token]); + $token_id = $results[0]['id']; + + $sql = 'INSERT INTO oauth_refresh_tokens' + . ' (refresh_token, access_token_id, expires_at, client_id)' + . ' VALUES' + . ' (?, ?, ?, ?);'; + + $this->db->execute($sql, [ + $token, + $token_id, + $expiration, + $this->server->getRequest()->request->get('client_id', null), + ]); + } + + public function delete(RefreshTokenEntity $token) + { + $sql = 'DELETE FROM oauth_refresh_tokens WHERE refresh_token = ?;'; + + $this->db->execute($sql, [$token->getId()]); + } +} + diff --git a/src/OAuth2/Resource.php b/src/OAuth2/Resource.php new file mode 100644 index 0000000..2ff78ae --- /dev/null +++ b/src/OAuth2/Resource.php @@ -0,0 +1,141 @@ +config['oauth'][$_SERVER['__version']])) + { + throw new \Exception('Forbidden.', 403); + } + elseif (!isset($_REQUEST['grant_type'])) + { + throw new \Exception('Bad Request.', 400); + } + + $config = $this->config['oauth'][$_SERVER['__version']]; + + switch (substr($_REQUEST['request'], strlen($_SERVER['__version']) + 2)) + { + case 'oauth/access_token': + try + { + $server = new AuthorizationServer; + + $server->setSessionStorage(new SessionStorage); + $server->setAccessTokenStorage(new AccessTokenStorage); + $server->setClientStorage(new ClientStorage); + $server->setScopeStorage(new ScopeStorage); + $server->setRefreshTokenStorage(new RefreshTokenStorage); + + $grant_type = $_REQUEST['grant_type']; + $grants = ['password']; + + if (isset($config['grants'])) + { + $grants = array_unique(array_merge($grants, $config['grants'])); + } + + if (!in_array($grant_type, $grants)) + { + throw new \Exception('Unsupported grant type.', 403); + } + + // Defaults TTLs to 1 day and 1 week respectively + $token_ttl = 3600; + $refresh_ttl = 604800; + + if (isset($config['ttl']['access_token'])) + { + $token_ttl = $config['ttl']['access_token']; + } + + switch ($grant_type) + { + case 'authorization_code': + throw new \Exception('Not Implemented', 501); + break; + + case 'client_credentials': + throw new \Exception('Not Implemented', 501); + break; + + case 'implicit': + throw new \Exception('Not Implemented', 501); + break; + + case 'password': + $grant = new PasswordGrant; + $grant->setAccessTokenTTL($token_ttl); + + $grant->setVerifyCredentialsCallback(function ($username, $password) + { + $user = new User([ + 'conditions' => [ + 'email' => $username, + ], + ]); + + return $user->count() + && password_verify($password, $user->record['password']); + }); + + break; + + case 'refresh_token': + throw new \Exception('Not Implemented', 501); + + // @todo Need to work through this, appears lib is busted + $grant = new RefreshTokenGrant; + //$grant->setAccessTokenTTL($refresh_ttl); + $server->addGrantType($grant); + break; + } + + $server->addGrantType($grant); + + // Adds the refresh token grant if enabled + if ($grant_type != 'refresh_token' + && in_array('refresh_token', $grants)) + { + if (isset($config['ttl']['refresh_token'])) + { + $refresh_ttl = $config['ttl']['refresh_token']; + } + + $grant = new RefreshTokenGrant; + $grant->setAccessTokenTTL($refresh_ttl); + $server->addGrantType($grant); + } + + $response = $server->issueAccessToken(); + + return $response; + } + catch (OAuthException $e) + { + throw new \Exception($e->getMessage(), $e->httpStatusCode); + } + catch (\Exception $e) + { + throw new \Exception($e->getMessage(), $e->getCode()); + } + + break; + + default: + throw new \Exception('Not Found.', 404); + break; + } + } +} + diff --git a/src/OAuth2/ScopeStorage.php b/src/OAuth2/ScopeStorage.php new file mode 100644 index 0000000..c614eb7 --- /dev/null +++ b/src/OAuth2/ScopeStorage.php @@ -0,0 +1,26 @@ +db->fetch($sql, [$scope]); + + if (count($results) === 0) + { + return null; + } + + return (new ScopeEntity($this->server))->hydrate([ + 'id' => $result[0]['id'], + 'description' => $result[0]['description'], + ]); + } +} + diff --git a/src/OAuth2/SessionStorage.php b/src/OAuth2/SessionStorage.php new file mode 100644 index 0000000..2754b1d --- /dev/null +++ b/src/OAuth2/SessionStorage.php @@ -0,0 +1,106 @@ +db->fetch($sql, [$access_token->getId()]); + + if (count($results) === 1) + { + $session = new SessionEntity($this->server); + $session->setId($result[0]['id']); + $session->setOwner($result[0]['owner_type'], $result[0]['owner_id']); + + return $session; + } + + return null; + } + + public function getByAuthCode(AuthCodeEntity $auth_code) + { + $sql = 'SELECT oauth_sessions.id, oauth_sessions.owner_type,' + . ' oauth_sessions.owner_id, oauth_sessions.client_id,' + . ' oauth_sessions.client_redirect_uri' + . ' FROM oauth_sessions' + . ' INNER JOIN oauth_authorization_codes' + . ' ON oauth_authorization_codes.session_id = oauth_sessions.id' + . ' WHERE oauth_authorization_codes.authorization_code = ?;'; + + $results = $this->db->fetch($sql, [$auth_code->getId()]); + + if (count($results) === 1) + { + $session = new SessionEntity($this->server); + $session->setId($result[0]['id']); + $session->setOwner($result[0]['owner_type'], $result[0]['owner_id']); + + return $session; + } + + return null; + } + + public function getScopes(SessionEntity $session) + { + $sql = 'SELECT oauth_sessions.*' + . ' FROM oauth_sessions' + . ' INNER JOIN oauth_access_token_scopes' + . ' ON oauth_sessions.id = oauth_access_token_scopes.access_token_id' + . ' INNER JOIN oauth_scopes' + . ' ON oauth_scopes.id = oauth_access_token_scopes.scope_id' + . ' WHERE oauth_sessions.id = ?;'; + + $results = $this->db->fetch($sql, [$session->getId()]); + $scopes = []; + + foreach ($results as $scope) + { + $scopes[] = (new ScopeEntity($this->server))->hydrate([ + 'id' => $scope['id'], + 'description' => $scope['description'], + ]); + } + + return $scopes; + } + + public function create($owner_type, $owner_id, $client_id, $client_redirect_uri = null) + { + $sql = 'INSERT INTO oauth_sessions' + . ' (owner_type, owner_id, client_id)' + . ' VALUES' + . ' (?, ?, ?);'; + + return $this->db->execute($sql, [$owner_type, $owner_id, $client_id]); + } + + public function associateScope(SessionEntity $session, ScopeEntity $scope) + { + $sql = 'INSERT INTO oauth_access_token_scopes' + . ' (access_token_id, scope_id)' + . ' VALUES' + . ' (?, ?);'; + + $this->db->execute($sql, [$session->getId(), $scope->getId()]); + } +} + diff --git a/src/OAuth2/StorageAdapter.php b/src/OAuth2/StorageAdapter.php new file mode 100644 index 0000000..27ab436 --- /dev/null +++ b/src/OAuth2/StorageAdapter.php @@ -0,0 +1,20 @@ +config = Config::getInstance(); + $this->db = Database::getInstance(); + } +} + diff --git a/src/classes/Object.php b/src/Object.php similarity index 50% rename from src/classes/Object.php rename to src/Object.php index 4847d45..42bb6c0 100644 --- a/src/classes/Object.php +++ b/src/Object.php @@ -1,24 +1,23 @@ * @copyright Copyright 2007-2014, Josh Sherman * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES * @link https://github.com/joshtronic/pickles + * @package Pickles */ +namespace Pickles; + /** * Object Class * - * Every instantiated class in PICKLES should be extending this class. By doing + * Every instantiated class in Pickles should be extending this class. By doing * so the class is automatically hooked into the profiler, and the object will * have access to some common components as well. */ @@ -40,65 +39,33 @@ class Object public $config = null; /** - * Instance of the Cache object + * Instance of the Mongo object * * @var object */ - public $cache = null; + public $mongo = null; /** - * Instance of the Database object + * Instance of the Redis object * * @var object */ - public $db = null; - - /** - * Profiler flag - * - * @var mixed - */ - public $profiler = false; + public $redis = null; /** * Constructor * * Establishes a Config instance for all children to enjoy */ - public function __construct($objects = null) + public function __construct() { - // Gets an instance of the config, unless we ARE the config - if (get_class($this) == 'Config') - { - $this->config = true; - } - else - { - $this->config = Config::getInstance(); - } - - if ($objects) - { - if (!is_array($objects)) - { - $objects = [$objects]; - } - - foreach ($objects as $object) - { - switch ($object) - { - case 'cache': $this->cache = Cache::getInstance(); break; - case 'db': $this->db = Database::getInstance(); break; - } - } - } - - // Assigns the profiler flag - $this->profiler = (isset($this->config->pickles['profiler']) && $this->config->pickles['profiler'] != '' ? $this->config->pickles['profiler'] : false); + // @todo Lazy load these so we're not loading them on every instance + $this->config = Config::getInstance(); + $this->mongo = Mongo::getInstance(); + //$this->redis = Redis::getInstance(); // Optionally logs the constructor to the profiler - if ($this->profiler === true || ((is_array($this->profiler) && in_array('objects', $this->profiler)) || stripos($this->profiler, 'objects') !== false)) + if ($this->config['profiler']) { Profiler::log($this, '__construct'); } @@ -117,14 +84,10 @@ class Object */ public static function getInstance($class = false) { - // In < 5.3 arguments must match in child, hence defaulting $class - // @todo Remove this, as we're no longer supporting 5.3 - if ($class == false) - { - return false; - } - else + if ($class) { + $class = 'Pickles\\' . $class; + if (!isset(self::$instances[$class])) { self::$instances[$class] = new $class(); @@ -132,6 +95,8 @@ class Object return self::$instances[$class]; } + + return false; } /** @@ -140,7 +105,7 @@ class Object public function __destruct() { // Optionally logs the destructor to the profiler - if ($this->profiler === true || ((is_array($this->profiler) && in_array('objects', $this->profiler)) || stripos($this->profiler, 'objects') !== false)) + if ($this->config['profiler']) { Profiler::log($this, '__destruct'); } diff --git a/src/Profiler.php b/src/Profiler.php new file mode 100644 index 0000000..969961f --- /dev/null +++ b/src/Profiler.php @@ -0,0 +1,196 @@ +Profiler::log('some action you want to track'); + * @usage Profiler::log($object, 'methodName'); + */ +class Profiler +{ + /** + * Logs + * + * Array of logged events + * + * @static + * @access private + * @var array + */ + private static $logs = []; + + /** + * Timers + * + * Array of active timers + * + * @static + * @access private + * @var array + */ + private static $timers = []; + + /** + * Log + * + * Logs the event to be displayed later on. Due to the nature of how much + * of a pain it is to determine which class method called this method I + * opted to make the method a passable argument for ease of use. Perhaps + * I'll revisit in the future. Handles all elapsed time calculations and + * memory usage. + * + * @static + * @param mixed $data data to log + * @param string $method name of the class method being logged + */ + public static function log($data, $method = false, $type = false) + { + $time = microtime(true); + $data_type = ($data == 'timer' ? $data : gettype($data)); + + // Tidys the data by type + switch ($data_type) + { + case 'object': + $details['class'] = get_class($data); + + if ($method != '') + { + $details['method'] = $method . '()'; + } + + $data_type = $data_type; + break; + + case 'timer': + $details = $method; + $data_type = $data_type; + break; + + default: + if ($type != false) + { + $data_type = $type; + } + + $details = $data; + break; + } + + self::$logs[] = [ + 'type' => $data_type, + 'timestamp' => $time, + 'elapsed_time' => $time - $_SERVER['REQUEST_TIME_FLOAT'], + 'memory_usage' => memory_get_usage(), + 'details' => $details, + ]; + } + + /** + * Query + * + * Serves as a wrapper to get query data to the log function + * + * @static + * @param string $query the query being executed + * @param array $input_parameters optional prepared statement data + * @param array $results optional results of the query + * @param float $duration the speed of the query + * @param array $explain EXPLAIN data for the query + */ + public static function query($query, $input_parameters = false, $results = false, $duration = false, $explain = false) + { + $log = [ + 'query' => $query, + 'parameters' => $input_parameters, + 'results' => $results, + 'execution_time' => $duration, + ]; + + if ($explain) + { + $log['explain'] = $explain; + } + + self::log($log, false, 'database'); + } + + /** + * Timer + * + * Logs the start and end of a timer. + * + * @param string $timer name of the timer + * @return boolean whether or not timer profiling is enabled + */ + public static function timer($timer) + { + // Starts the timer + if (!isset(self::$timers[$timer])) + { + self::$timers[$timer] = microtime(true); + + self::Log('timer', [ + 'action' => 'start', + 'name' => $timer + ]); + } + // Ends the timer + else + { + self::Log('timer', [ + 'action' => 'stop', + 'name' => $timer, + 'elapsed_time' => (microtime(true) - self::$timers[$timer]) + ]); + + unset(self::$timers[$timer]); + } + } + + /** + * Report + * + * Generates the Profiler report that is displayed by the Controller. + * Contains all the HTML needed to display the data properly inline on the + * page. Will generally be displayed after the closing HTML tag. + */ + public static function report() + { + $report = [ + 'request_time' => $_SERVER['REQUEST_TIME_FLOAT'], + 'execution_time' => self::$logs[count(self::$logs) - 1]['timestamp'] + - $_SERVER['REQUEST_TIME_FLOAT'], + 'peak_memory_usage' => memory_get_peak_usage(), + 'max_execution_time' => ini_get('max_execution_time'), + 'memory_limit' => ini_get('memory_limit'), + 'included_files' => count(get_included_files()), + 'logs' => self::$logs, + ]; + + self::$logs = []; + self::$timers = []; + + return $report; + } +} + diff --git a/src/Resource.php b/src/Resource.php new file mode 100644 index 0000000..fadd62f --- /dev/null +++ b/src/Resource.php @@ -0,0 +1,387 @@ +uids = $uids; + $method = $_SERVER['REQUEST_METHOD']; + + try + { + // Checks if auth flag is explicity true or true for the method + if ($this->auth === true + || (isset($this->auth[$method]) && $this->auth[$method])) + { + if (isset($this->config['oauth'][$_SERVER['__version']])) + { + $server = new ResourceServer( + new SessionStorage, + new AccessTokenStorage, + new ClientStorage, + new ScopeStorage + ); + + $server->isValidRequest(); + } + else + { + throw new \Exception('Authentication is not configured properly.', 401); + } + } + + // Hacks together some new globals + if (in_array($method, ['PUT', 'DELETE'])) + { + $GLOBALS['_' . $method] = []; + + // @todo Populate it + } + + $filter = isset($this->filter[$method]); + $validate = isset($this->validate[$method]); + + if ($filter || $validate) + { + $global =& $GLOBALS['_' . $method]; + + // Checks that the required parameters are present + // @todo Add in support for uid:* variables + if ($validate) + { + $variables = []; + + foreach ($this->validate[$method] as $variable => $rules) + { + if (!is_array($rules)) + { + $variable = $rules; + } + + $variables[] = $variable; + } + + $missing_variables = array_diff($variables, array_keys($global)); + + if ($missing_variables !== array()) + { + foreach ($missing_variables as $variable) + { + $this->errors[$variable][] = 'The ' . $variable . ' parameter is required.'; + } + } + } + + foreach ($global as $variable => $value) + { + // Applies any filters + if ($filter && isset($this->filter[$method][$variable])) + { + $function = $this->filter[$method][$variable]; + + if ($function == 'password_hash') + { + $global[$variable] = password_hash($value, PASSWORD_DEFAULT); + } + else + { + $global[$variable] = $function($value); + } + } + + if ($validate && isset($this->validate[$method][$variable])) + { + $rules = $this->validate[$method][$variable]; + + if (is_array($rules)) + { + if (isset($global[$variable]) && !String::isEmpty($global[$variable])) + { + if (is_array($rules)) + { + foreach ($rules as $rule => $message) + { + $rule = explode(':', $rule); + + for ($i = 1; $i <= 2; $i++) + { + if (!isset($rule[$i])) + { + $rule[$i] = false; + } + } + + switch ($rule[0]) + { + // {{{ Checks using filter_var() + + case 'filter': + switch ($rule[1]) + { + case 'boolean': + case 'email': + case 'float': + case 'int': + case 'ip': + case 'url': + $filter = constant('FILTER_VALIDATE_' . strtoupper($rule[1])); + + if (!filter_var($value, $filter)) + { + $this->errors[$variable][] = $message; + } + break; + + default: + $this->errors[$variable] = 'Invalid filter, expecting boolean, email, float, int, ip or url.'; + break; + } + + break; + + // }}} + // {{{ Checks using strlen() + + case 'length': + $length = strlen($value); + + switch ($rule[1]) + { + case '<': + $valid = $length < $rule[2]; + break; + + case '<=': + $valid = $length <= $rule[2]; + break; + + case '==': + $valid = $length == $rule[2]; + break; + + case '!=': + $valid = $length != $rule[2]; + break; + + case '>=': + $valid = $length >= $rule[2]; + break; + + case '>': + $valid = $length > $rule[2]; + break; + + default: + $valid = false; + $message = 'Invalid operator, expecting <, <=, ==, !=, >= or >.'; + break; + } + + if (!$valid) + { + $this->errors[$variable][] = $message; + } + + break; + + // }}} + // {{{ Checks using preg_match() + + case 'regex': + if (preg_match($rule[1], $value)) + { + $this->errors[$variable][] = $message; + } + break; + + // }}} + // @todo case 'alpha': + // @todo case 'alphanumeric': + // @todo case 'date': + // @todo case 'range': + } + } + } + } + } + } + } + + // if PUT or DELETE, need to update the super globals directly as + // they do not stay in sync. Probably need to make them global in + // this class method + // + // $_PUT = $GLOBALS['_PUT']; + } + + if ($this->errors) + { + throw new \Exception('Missing or invalid parameters.', 400); + } + + parent::__construct(); + + // Checks if the request method has been implemented + if (get_class($this) != 'Pickles\\Resource') + { + if (!method_exists($this, $method)) + { + throw new \Exception('Method not allowed.', 405); + } + else + { + // Starts a timer before the resource is executed + if ($this->config['profiler']) + { + $timer = get_class($this) . '->' . $method . '()'; + Profiler::timer($timer); + } + + $this->response = $this->$method(); + + // Stops the resource timer + if ($this->config['profiler']) + { + Profiler::timer($timer); + } + } + } + } + catch (\Exception $e) + { + $code = $e->getCode(); + + // Anything below 200 is probably a PHP error + if ($code < 200) + { + $code = 500; + } + + $this->status = $code; + $this->message = $e->getMessage(); + } + } + + public function respond() + { + http_response_code($this->status); + header('Content-Type: application/json'); + header('X-Powered-By: Pickles (http://picklesphp.com)'); + + $meta = [ + 'status' => $this->status, + 'message' => $this->message, + ]; + + // Forces errors to be an array of arrays + if ($this->errors) + { + foreach ($this->errors as $key => $error) + { + if (!is_array($error)) + { + $this->errors[$key] = [$error]; + } + } + } + + foreach (['echo', 'limit', 'offset', 'errors'] as $variable) + { + if ($this->$variable) + { + $meta[$variable] = $this->$variable; + } + } + + $response = ['meta' => $meta]; + + foreach (['response', 'profiler'] as $variable) + { + if ($this->$variable) + { + $response[$variable] = $this->$variable; + } + } + + if ($this->config['profiler']) + { + $response['profiler'] = Profiler::report(); + } + + $pretty = isset($_REQUEST['pretty']) ? JSON_PRETTY_PRINT : false; + + echo json_encode($response, $pretty); + } +} + diff --git a/src/Router.php b/src/Router.php new file mode 100644 index 0000000..2089c90 --- /dev/null +++ b/src/Router.php @@ -0,0 +1,113 @@ +new Pickles\Router; + */ +class Router extends Object +{ + /** + * Constructor + * + * To save a few keystrokes, the Controller is executed as part of the + * constructor instead of via a method. You either want the Controller or + * you don't. + */ + public function __construct() + { + parent::__construct(); + + try + { + // Secure by default + if (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == false) + { + throw new \Exception('HTTPS is required.', 400); + } + + // Grabs the requested page + $request = $_REQUEST['request']; + $components = explode('/', $request); + $nouns = []; + $uids = []; + $version = array_shift($components); + $_SERVER['__version'] = substr($version, 1); + + // Checks if we're trying to rock some OAuth + if ($components[0] == 'oauth') + { + $class = 'Pickles\OAuth2\Resource'; + } + else + { + // Loops through the components to determine nouns and IDs + foreach ($components as $index => $component) + { + if ($index % 2) + { + $uids[end($nouns)] = $component; + } + else + { + $nouns[] = $component; + } + } + + // Creates our class name + array_unshift($nouns, '', 'Pickles', 'App', 'Resources', $version); + $class = implode('\\', $nouns); + } + + // Checks that the file is present and contains our class + if (!class_exists($class)) + { + throw new \Exception('Not Found.', 404); + } + + // Instantiates our resource with the UIDs + $resource = new $class($uids); + } + catch (\Exception $e) + { + // Creates a resource object if we don't have one + if (!isset($resource)) + { + $resource = new Resource; + } + + $code = $e->getCode(); + + // Anything below 200 is probably a PHP error + if ($code < 200) + { + $code = 500; + } + + $resource->status = $code; + $resource->message = $e->getMessage(); + } + + $resource->respond(); + } +} + diff --git a/src/classes/String.php b/src/String.php similarity index 98% rename from src/classes/String.php rename to src/String.php index f51ac3c..3b8dc8d 100644 --- a/src/classes/String.php +++ b/src/String.php @@ -3,18 +3,17 @@ /** * String Utility Collection * - * PHP version 5 - * * Licensed under The MIT License * Redistribution of these files must retain the above copyright notice. * - * @author Josh Sherman * @copyright Copyright 2007-2014, Josh Sherman * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES * @link https://github.com/joshtronic/pickles + * @package Pickles */ +namespace Pickles; + /** * String Class * @@ -63,7 +62,7 @@ class String $string = strtolower(trim($string)); $string = preg_replace('/[^a-z0-9-]/', '-', $string); $string = preg_replace('/-+/', '-', $string); - return trim($string, '-');; + return trim($string, '-'); } // }}} diff --git a/src/classes/Time.php b/src/Time.php similarity index 95% rename from src/classes/Time.php rename to src/Time.php index 1f7ca66..0811d01 100644 --- a/src/classes/Time.php +++ b/src/Time.php @@ -3,18 +3,17 @@ /** * Time Utility Collection * - * PHP version 5 - * * Licensed under The MIT License * Redistribution of these files must retain the above copyright notice. * - * @author Josh Sherman * @copyright Copyright 2007-2014, Josh Sherman * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES * @link https://github.com/joshtronic/pickles + * @package Pickles */ +namespace Pickles; + /** * Time Class * @@ -116,9 +115,6 @@ class Time * @static * @param string $date birth / inception date * @return integer $age number of years old - * @todo Wondering if this really should live in the Date class since - * it's a Date function. Could flip the aliasing to preserve any - * older code. */ public static function age($date) { diff --git a/src/classes/Browser.php b/src/classes/Browser.php deleted file mode 100644 index 41e4faa..0000000 --- a/src/classes/Browser.php +++ /dev/null @@ -1,287 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Browser Utility Class - * - * Just a simple collection of static functions to accomplish some of the - * more redundant browser-related tasks. - */ -class Browser extends Object -{ - /** - * Attributes - * - * Variables passed on the query string as /var:value/ - * - * @access private - * @var array - */ - private $attributes = []; - - /** - * Get instance of the object - * - * Let's the parent class do all the work - * - * @static - * @param string $class name of the class to instantiate - * @return object self::$instance instance of the Config class - */ - public static function getInstance($class = 'Browser') - { - return parent::getInstance($class); - } - - /** - * Set browser variable - * - * Sets a variable in the attributes array for easier access later. - * - * @static - * @param string $variable name of the variable to set - * @param mixed $value the value to set to the variable - * @return boolean true - */ - public static function set($variable, $value) - { - $browser = Browser::getInstance(); - $browser->attributes[$variable] = $value; - - return true; - } - - /** - * Get browser variable - * - * Gets a variable passed in from the browser. Currently only supports - * the custom attribute URI format /$variable:$value/. - * - * @static - * @param string $variable name of the variable to get - * @return mixed the value of the variable or boolean false if not set - */ - public static function get($variable) - { - $browser = Browser::getInstance(); - - if (isset($browser->attributes[$variable])) - { - return $browser->attributes[$variable]; - } - - return false; - } - - /** - * Go Home - * - * Alias for `Browser::redirect('/');` - * - * @static - */ - public static function goHome() - { - return Browser::redirect('/'); - } - - /** - * Is Mobile - * - * Detects if we're working with a mobile browser. - * - * @return boolean whether or not the browser is considered mobile - */ - public static function isMobile() - { - $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null; - - return preg_match('/android|avantgo|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i', $user_agent) || preg_match('/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|e\-|e\/|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(di|rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|xda(\-|2|g)|yas\-|your|zeto|zte\-/i', substr($user_agent, 0, 4)) || strpos('iPhone', $user_agent); - } - - /** - * Redirect - * - * Redirects the browser to another URL. Stops execution as to not run - * code erroneously due to output buffering. HTTP/1.1 request an - * absolute URI, hence the inclusion of the scheme, hostname and - * absolute path if :// is not found. Don't hate the player, hate the - * RFC. - * - * @static - * @param string $destination URL to redirect to - * @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30 - */ - public static function redirect($destination) - { - if (strpos($destination, '://') === false) - { - $destination = 'http' . ((!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == 'off' || $_SERVER['HTTPS'] == '') ? '' : 's') . '://' . $_SERVER['HTTP_HOST'] . $destination; - } - - header('Location: ' . $destination); - exit; - } - - /** - * Refresh - * - * Forces a browser refresh of the currently requested page. - * - * @static - */ - public static function refresh() - { - Browser::redirect($_SERVER['REQUEST_URI']); - } - - /** - * Remote IP - * - * Returns the user's IP address. - * - * @return mixed IP address or false if unable to determine - */ - public static function remoteIP() - { - if (!empty($_SERVER['HTTP_CLIENT_IP'])) - { - $ip = $_SERVER['HTTP_CLIENT_IP']; - } - elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) - { - $ip = $_SERVER['HTTP_X_FORWARDED_FOR']; - } - elseif (isset($_SERVER['REMOTE_ADDR'])) - { - $ip = $_SERVER['REMOTE_ADDR']; - } - else - { - $ip = false; - } - - return $ip; - } - - /** - * Status - * - * Pushes a status code to the browser. Some of these codes are site - * (420) and server (444) specific, some just for LOLs (418) and some - * that are still in draft (425) and subject to change. I wanted this - * to be a complete list and in the scenario that a code had multiple - * meanings, I favored a more recent RFC (424) even if merely a draft - * (451). - * - * @static - * @param integer status response code - */ - public static function status($code = 200) - { - switch ($code) - { - // {{{ 1xx Informational - case 100: $message = '100 Continue'; break; - case 101: $message = '101 Switching Protocols'; break; - case 102: $message = '102 Processing'; break; - // }}} - // {{{ 2xx Success - case 201: $message = '201 Created'; break; - case 202: $message = '202 Accepted'; break; - case 203: $message = '203 Non-Authoritative Information'; break; - case 204: $message = '204 No Content'; break; - case 205: $message = '205 Reset Content'; break; - case 206: $message = '206 Partial Content'; break; - case 207: $message = '207 Multi-Status'; break; - case 208: $message = '208 Already Reported'; break; - case 226: $message = '226 IM Used'; break; - // }}} - // {{{ 3xx Redirection - case 300: $message = '300 Multiple Choices'; break; - case 301: $message = '301 Moved Permanently'; break; - case 302: $message = '302 Found'; break; - case 303: $message = '303 See Other'; break; - case 304: $message = '304 Not Modified'; break; - case 305: $message = '305 Use Proxy'; break; - case 306: $message = '306 Switch Proxy'; break; - case 307: $message = '307 Temporary Redirect'; break; - case 308: $message = '308 Permanent Redirect'; break; - // }}} - // {{{ 4xx Client Error - case 400: $message = '400 Bad Request'; break; - case 401: $message = '401 Unauthorized'; break; - case 402: $message = '402 Payment Required'; break; - case 403: $message = '403 Forbidden'; break; - case 404: $message = '404 Not Found'; break; - case 405: $message = '405 Method Not Allowed'; break; - case 406: $message = '406 Not Acceptable'; break; - case 407: $message = '407 Proxy Authentication Required'; break; - case 408: $message = '408 Request Timeout'; break; - case 409: $message = '409 Conflict'; break; - case 410: $message = '410 Gone'; break; - case 411: $message = '411 Length Required'; break; - case 412: $message = '412 Precondition Failed'; break; - case 413: $message = '413 Request Entity Too Large'; break; - case 414: $message = '414 Request-URI Too Long'; break; - case 415: $message = '415 Unsupported Media Type'; break; - case 416: $message = '416 Requested Range Not Satisfied'; break; - case 417: $message = '417 Expectation Failed'; break; - case 418: $message = '418 I\'m a teapot'; break; - case 420: $message = '420 Enhance Your Calm'; break; - case 422: $message = '422 Unprocessed Entity'; break; - case 423: $message = '423 Locked'; break; - case 424: $message = '424 Failed Dependency'; break; - case 425: $message = '425 Unordered Collection'; break; - case 426: $message = '426 Upgrade Required'; break; - case 428: $message = '428 Precondition Required'; break; - case 429: $message = '429 Too Many Requests'; break; - case 431: $message = '431 Request Header Fields Too Large'; break; - case 444: $message = '444 No Response'; break; - case 449: $message = '449 Retry With'; break; - case 450: $message = '450 Blocked by Windows Parental Controls'; break; - case 451: $message = '451 Unavailable for Legal Reasons'; break; - case 494: $message = '494 Request Header Too Large'; break; - case 495: $message = '495 Cert Error'; break; - case 496: $message = '496 No Cert'; break; - case 497: $message = '497 HTTP to HTTPS'; break; - case 499: $message = '499 Client Closed Request'; break; - // }}} - // {{{ 5xx Server Error - case 500: $message = '500 Internal Server Error'; break; - case 501: $message = '501 Not Implemented'; break; - case 502: $message = '502 Bad Gateway'; break; - case 503: $message = '503 Service Unavailable'; break; - case 504: $message = '504 Gateway Timeout'; break; - case 505: $message = '505 HTTP Version Not Supported'; break; - case 506: $message = '506 Variant Also Negotiates'; break; - case 507: $message = '507 Insufficient Storage'; break; - case 508: $message = '508 Loop Detected'; break; - case 509: $message = '509 Bandwidth Limit Exceeded'; break; - case 510: $message = '510 Not Extended'; break; - case 511: $message = '511 Network Authentication Required'; break; - case 598: $message = '598 Network read timeout error'; break; - case 599: $message = '599 Network connect timeout error'; break; - // }}} - default: $message = '200 OK'; break; - } - - header('HTTP/1.1 ' . $message, true, $code); - header('Status: ' . $message, true, $code); - } -} - diff --git a/src/classes/Cache.php b/src/classes/Cache.php deleted file mode 100644 index 5a02d70..0000000 --- a/src/classes/Cache.php +++ /dev/null @@ -1,222 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Cache Class - * - * Wrapper class for Memcache() to allow for better error handling when the - * Memcached server is unavailable. Designed around the syntax for Memcached() - * to allow for an easier transistion to the aforementioned in the future. I - * don't entirely remember specifics, but the reason for not using Memcached() - * was due to an unexplainable bug in the version in the repository for Ubuntu - * 10.04 LTS. Memcached() does support more of the memcached protocol and will - * eventually be what PICKLES uses. Keys are forced to be uppercase for - * consistencies sake as I've been burned by the case sensitivity due to typos - * in my code. - * - * Requires php5-memcache - * - * @link http://us.php.net/manual/en/book.memcache.php - * @link http://packages.ubuntu.com/lucid/php5-memcache - * @link http://www.memcached.org/ - */ -class Cache extends Object -{ - /** - * Namespace (prefix) - * - * @access private - * @var string - */ - private $namespace = ''; - - /** - * Servers - * - * @access private - * @var integer - */ - private $servers = 0; - - /** - * Connection resource to Memcached - * - * @access private - * @var object - */ - private $connection = null; - - /** - * Constructor - * - * Sets up our connection variables. - * - * @param string $hostname optional hostname to connect to - * @param string $database optional port to use - */ - public function __construct() - { - parent::__construct(); - - // @todo Shouldn't need the isset() but Travis is failing some tests - if (isset($this->config->pickles['cache']) && $this->config->pickles['cache']) - { - $datasources = $this->config->pickles['cache']; - - if (!is_array($datasources)) - { - $datasources = [$datasources]; - } - - $this->connection = new Memcache(); - - foreach ($datasources as $name) - { - if (isset($this->config->datasources[$name])) - { - $datasource = $this->config->datasources[$name]; - - $this->connection->addServer($datasource['hostname'], $datasource['port']); - $this->servers++; - - if (isset($datasource['namespace'])) - { - $this->namespace = $datasource['namespace']; - } - } - } - } - - if ($this->namespace != '') - { - $this->namespace .= '-'; - } - } - - /** - * Destructor - * - * Closes the connection when the object dies. - */ - public function __destruct() - { - if ($this->servers) - { - $this->connection->close(); - } - } - - /** - * Get Instance - * - * Let's the parent class do all the work. - * - * @static - * @param string $class name of the class to instantiate - * @return object self::$instance instance of the Cache class - */ - public static function getInstance($class = 'Cache') - { - return parent::getInstance($class); - } - - /** - * Get Key - * - * Gets the value of the key(s) and returns it. - * - * @param mixed $keys key(s) to retrieve - * @return mixed value(s) of the requested key(s), false if not set - */ - public function get($keys) - { - if (is_array($keys)) - { - foreach ($keys as $index => $key) - { - $keys[$index] = strtoupper($this->namespace . $key); - } - } - else - { - $keys = strtoupper($this->namespace . $keys); - } - - return $this->connection->get($keys); - } - - /** - * Set Key - * - * Sets key to the specified value. I've found that compression can lead to - * issues with integers and can slow down the storage and retrieval of data - * (defeats the purpose of caching if you ask me) and isn't supported. I've - * also been burned by data inadvertantly being cached for infinity, but - * have had great success caching data for a full day, hence defaulting the - * expiration to a full day. - * - * @param string $key key to set - * @param mixed $value value to set - * @param integer $expiration optional expiration, defaults to 1 day - * @return boolean status of writing the data to the key - */ - public function set($key, $value, $expire = Time::DAY) - { - $key = strtoupper($key); - - return $this->connection->set(strtoupper($this->namespace . $key), $value, 0, $expire); - } - - /** - * Delete Key - * - * Deletes the specified key(s). - * - * @param mixed $keys key(s) to delete - * @return boolean status of deleting the key - */ - public function delete($keys) - { - if (!is_array($keys)) - { - $keys = [$keys]; - } - - // Memcache() doesn't let you pass an array to delete all records the same way you can with get() - foreach ($keys as $key) - { - $this->connection->delete(strtoupper($this->namespace . $key)); - } - - return true; - } - - /** - * Increment Key - * - * Increments the value of an existing key. - * - * @param string $key key to increment - * @return boolean status of incrementing the key - * @todo Check if it's set as Memcache() doesn't and won't inc if it doesn't exist - */ - public function increment($key) - { - return $this->connection->increment(strtoupper($this->namespace . $key)); - } -} - diff --git a/src/classes/Config.php b/src/classes/Config.php deleted file mode 100644 index 3dbcfe4..0000000 --- a/src/classes/Config.php +++ /dev/null @@ -1,255 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Config Class - * - * Handles loading the site's configuration file (if available). At the moment - * this class is a very skewed Singleton. The plan is to eventually extend this - * out to support multiple configuration files, and the ability to load in - * custom config files on the fly as well. The core of PICKLES uses the class - * as a Singleton so we're not loading the configuration multiple times per - * page load. - * - * @usage $config = new Config($filename); - */ -class Config extends Object -{ - /** - * Config data - * - * @var array - */ - public $data = []; - - /** - * Constructor - * - * Calls the parent constructor and loads the passed file. - */ - public function __construct() - { - parent::__construct(); - - $filename = SITE_PATH . 'config.php'; - $environments = false; - $environment = false; - $is_cli = !isset($_SERVER['REQUEST_METHOD']); - - - // Sanity checks the config file - if (file_exists($filename) && is_file($filename) && is_readable($filename)) - { - require $filename; - } - - // Checks that we have the config array - if (isset($config)) - { - // Determines the environment - if (isset($config['environment'])) - { - $environment = $config['environment']; - } - else - { - if (isset($config['environments']) && is_array($config['environments'])) - { - $environments = $config['environments']; - - // If we're on the CLI, check an environment was even passed in - // @todo is checking for argc enough? - if ($is_cli && $_SERVER['argc'] < 2) - { - throw new Exception('You must pass an environment (e.g. php script.php )'); - } - - // Loops through the environments and tries to match on IP or name - foreach ($config['environments'] as $name => $hosts) - { - if (!is_array($hosts)) - { - $hosts = [$hosts]; - } - - // Tries to determine the environment name - foreach ($hosts as $host) - { - if ($is_cli) - { - // Checks the first argument on the command line - if ($_SERVER['argv'][1] == $name) - { - $environment = $name; - break; - } - } - else - { - // Exact match - if ((preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $host) - && $_SERVER['SERVER_ADDR'] == $host) - || (isset($_SERVER['HTTP_HOST']) && $_SERVER['HTTP_HOST'] == $host)) - { - $environment = $name; - break; - } - // Fuzzy match - elseif (substr($host,0,1) == '/' && (preg_match($host, $_SERVER['SERVER_NAME'], $matches) > 0 || preg_match($host, $_SERVER['HTTP_HOST'], $matches) > 0)) - { - $environments[$name] = $matches[0]; - $environment = $name; - $config['environments'][$name] = $matches[0]; - break; - } - } - } - } - } - } - - // Flattens the array based on the environment - $this->data = $this->flatten($environment, $config); - - // Restore environments value - if ($environments != false) - { - $this->data['environments'] = $environments; - } - - // Sets the environment if it's not set already - if (!isset($this->data['environment'])) - { - $this->data['environment'] = $environment; - } - - // Defaults profiler to true if it doesn't match an option exactly - if (isset($this->data['pickles']['profiler'])) - { - // If we have an array convert to a string - if (is_array($this->data['pickles']['profiler'])) - { - $this->data['pickles']['profiler'] = implode(',', $this->data['pickles']['profiler']); - } - } - else - { - $this->data['pickles']['profiler'] = false; - } - - // Defaults expected PICKLES options to false - foreach (['cache', 'logging', 'minify'] as $variable) - { - if (!isset($this->data['pickles'][$variable])) - { - $this->data['pickles'][$variable] = false; - } - } - - // Creates constants for the security levels - if (isset($this->data['security']['levels']) && is_array($this->data['security']['levels'])) - { - foreach ($this->data['security']['levels'] as $value => $name) - { - $constant = 'SECURITY_LEVEL_' . strtoupper($name); - - // Checks if constant is already defined, and throws an error - if (defined($constant)) - { - throw new Exception('The constant ' . $constant . ' is already defined'); - } - else - { - define($constant, $value); - } - } - } - - return true; - } - - return false; - } - - /** - * Flatten - * - * Flattens the configuration array around the specified environment. - * - * @param string $environment selected environment - * @param array $array configuration error to flatten - * @return array flattened configuration array - */ - public function flatten($environment, $array) - { - if (is_array($array)) - { - foreach ($array as $key => $value) - { - if (is_array($value)) - { - if (isset($value[$environment])) - { - $value = $value[$environment]; - } - else - { - $value = $this->flatten($environment, $value); - } - } - - $array[$key] = $value; - } - } - - return $array; - } - - /** - * Get instance of the object - * - * Let's the parent class do all the work - * - * @static - * @param string $class name of the class to instantiate - * @return object self::$instance instance of the Config class - */ - public static function getInstance($class = 'Config') - { - return parent::getInstance($class); - } - - /** - * Magic Getter Method - * - * Attempts to load the config variable. If it's not set, will override - * the variable with boolean false. - * - * @param string $name name of the variable requested - * @return mixed value of the variable or boolean false - */ - public function __get($name) - { - if (!isset($this->data[$name])) - { - $this->data[$name] = false; - } - - return $this->data[$name]; - } -} - diff --git a/src/classes/Controller.php b/src/classes/Controller.php deleted file mode 100644 index 63e5228..0000000 --- a/src/classes/Controller.php +++ /dev/null @@ -1,433 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Controller Class - * - * The heavy lifter of PICKLES, makes the calls to get the session and - * configuration loaded. Loads modules, serves up user authentication when the - * module asks for it, and loads the viewer that the module requested. Default - * values are present to make things easier on the user. - * - * @usage new Controller(); - */ -class Controller extends Object -{ - /** - * Constructor - * - * To save a few keystrokes, the Controller is executed as part of the - * constructor instead of via a method. You either want the Controller or - * you don't. - */ - public function __construct() - { - parent::__construct(); - - // Generate a generic "site down" message if the site is set to be disabled - try - { - // @todo Clean this up to be just a single sanity check - if (isset($this->config->pickles['disabled']) && $this->config->pickles['disabled']) - { - $custom_template = SITE_TEMPLATE_PATH . '__shared/maintenance.phtml'; - - if (file_exists($custom_template)) - { - require_once $custom_template; - } - else - { - echo ' -

Down for Maintenance

-

- ' . $_SERVER['SERVER_NAME'] . ' is currently down for maintenance. - Please check back in a few minutes. -

-

Additionally, a custom maintenance template was not found.

-
- Powered by PICKLES - '; - } - - throw new Exception(); - } - - // Checks for attributes passed in the URI - if (strstr($_REQUEST['request'], ':')) - { - $parts = explode('/', $_REQUEST['request']); - $_REQUEST['request'] = ''; - - foreach ($parts as $part) - { - if (strstr($part, ':')) - { - list($variable, $value) = explode(':', $part); - Browser::set($variable, $value); - } - else - { - $_REQUEST['request'] .= ($_REQUEST['request'] ? '/' : '') . $part; - } - } - } - - // Catches requests that aren't lowercase - $lowercase_request = strtolower($_REQUEST['request']); - - if ($_REQUEST['request'] != $lowercase_request) - { - // @todo Rework the Browser class to handle the 301 (perhaps redirect301()) to not break other code - header('Location: ' . substr_replace($_SERVER['REQUEST_URI'], $lowercase_request, 1, strlen($lowercase_request)), true, 301); - throw new Exception(); - } - - // Grabs the requested page - $request = $_REQUEST['request']; - - // Loads the module's information - $module_class = strtr($request, '/', '_'); - $module_filename = SITE_MODULE_PATH . $request . '.php'; - $module_exists = file_exists($module_filename); - - // Attempts to instantiate the requested module - if ($module_exists) - { - if (class_exists($module_class)) - { - $module = new $module_class; - } - } - - // No module instantiated, load up a generic Module - if (!isset($module)) - { - $module = new Module(); - } - - // Determines if we need to serve over HTTP or HTTPS - if ($module->secure == false && isset($_SERVER['HTTPS']) && $_SERVER['HTTPS']) - { - header('Location: http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], true, 301); - throw new Exception(); - } - elseif ($module->secure == true && (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == false)) - { - header('Location: https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], true, 301); - throw new Exception(); - } - - // Validates security level - if ($module->security) - { - $is_authenticated = false; - - if (is_array($module->security)) - { - $module_security = $module->security; - $security_check_class = 'isLevel'; - - // Checks the type and validates it - if (isset($module_security['type'])) - { - $security_check_type = strtoupper($module_security['type']); - - if (in_array($security_check_type, ['IS', 'HAS', 'BETWEEN'])) - { - $security_check_class = $security_check_type; - } - - unset($module_security['type']); - } - - $module_security_levels = []; - - // If there's a level(s) key use it - foreach (['level', 'levels'] as $security_level_key) - { - if (isset($module_security[$security_level_key])) - { - if (is_array($module_security[$security_level_key])) - { - $module_security_levels = array_merge($module_security_levels, $module_security[$security_level_key]); - } - else - { - $module_security_levels[] = $module_security[$security_level_key]; - } - - unset($module_security[$security_level_key]); - } - } - - // Assume everything left in the array is a level and add it to the array - array_merge($module_security_levels, $module_security); - $security_level_count = count($module_security_levels); - - switch ($security_check_class) - { - // @todo Thinking of removing this? - case 'BETWEEN': - if ($security_level_count == 2) - { - $is_authenticated = Security::betweenLevel($module_security_levels[0], array_pop($module_security_levels)); - } - break; - - case 'HAS': - if ($security_level_count) - { - $is_authenticated = Security::hasLevel($module_security_levels); - } - break; - - case 'IS': - if ($security_level_count) - { - $is_authenticated = Security::isLevel($module_security_levels); - } - break; - } - } - else - { - $is_authenticated = Security::isLevel($module->security); - } - - if (!$is_authenticated) - { - if ($_SERVER['REQUEST_METHOD'] == 'POST') - { - // @todo Perhaps I could force a logout / redirect to the login page - Browser::status(401); - - throw new Exception(json_encode([ - 'status' => 401, - 'message' => 'You are not properly authenticated, try logging out and back in.', - ])); - } - else - { - // Sets variable for the destination - $_SESSION['__pickles']['login']['destination'] = $_REQUEST['request'] ? $_REQUEST['request'] : '/'; - - // Redirect to login page - Browser::redirect('/login'); - - // Resolves testing error due to undefined $output - $output = ''; - } - } - } - - // Gets the profiler status - $profiler = $this->config->pickles['profiler']; - $profiler = $profiler === true || stripos($profiler, 'timers') !== false; - - $default_method = '__default'; - $role_method = null; - - if (isset($_SESSION['__pickles']['security']['role']) && !String::isEmpty($_SESSION['__pickles']['security']['role'])) - { - $role_method = '__default_' . $_SESSION['__pickles']['security']['role']; - - if (method_exists($module, $role_method)) - { - $default_method = $role_method; - } - } - - // Attempts to execute the default method - // @todo Seems a bit redundant, refactor - if ($default_method == $role_method || method_exists($module, $default_method)) - { - // Starts a timer before the module is executed - if ($profiler) - { - Profiler::timer('module ' . $default_method); - } - - $valid_request = false; - $error_message = 'An unexpected error has occurred.'; - - // Determines if the request method is valid for this request - if ($module->method) - { - if (!is_array($module->method)) - { - $module->method = [$module->method]; - } - - foreach ($module->method as $method) - { - if ($_SERVER['REQUEST_METHOD'] == $method) - { - $valid_request = true; - break; - } - } - - if (!$valid_request) - { - // @todo Should probably utilize that AJAX flag to determine the type of return - $error_message = 'There was a problem with your request method.'; - } - } - else - { - $valid_request = true; - } - - $valid_form_input = true; - - if ($valid_request && $module->validate) - { - $validation_errors = $module->__validate(); - - if ($validation_errors) - { - $error_message = implode(' ', $validation_errors); - $valid_form_input = false; - } - } - - /** - * Note to Self: When building in caching will need to let the - * module know to use the cache, either passing in a variable - * or setting it on the object - */ - if ($valid_request && $valid_form_input) - { - $module_return = $module->$default_method(); - - if (!is_array($module_return)) - { - $module_return = $module->return; - } - else - { - $module_return = array_merge($module_return, $module->return); - } - } - - // Stops the module timer - if ($profiler) - { - Profiler::timer('module ' . $default_method); - } - - // Checks if we have any templates - $parent_template = $module->template; - $template_exists = $this->validateTemplates($module, $parent_template); - - // No templates? 404 that shit - if (!$module_exists && !$template_exists) - { - Browser::status(404); - $_REQUEST['request'] = '__shared/404'; - - if (!$this->validateTemplates($module, $parent_template)) - { - throw new Exception(' -

Not Found

-

The requested URL /' . $request . ' was not found on this server.

-

Additionally, a custom error template was not found.

-
- Powered by PICKLES - '); - } - } - - if (!isset($module_return)) - { - $module_return = [ - 'status' => 'error', - 'message' => $error_message, - ]; - } - - // @todo Should simplify this, give Display direct acess to - // $module instead of all these variable assignment - $display = new Display(); - $display->output = $module->output; - $display->templates = $module->template; - $display->module = $module_return; - - // @todo Check for $module->meta variable first, then remove entirely when sites are updated - $display->meta = [ - 'title' => $module->title, - 'description' => $module->description, - 'keywords' => $module->keywords - ]; - } - - // Starts a timer for the display rendering - if ($profiler) - { - Profiler::timer('display render'); - } - - // Renders the content - $output = $display->render(); - - // Stops the display timer - if ($profiler) - { - Profiler::timer('display render'); - } - } - catch (Exception $e) - { - $output = $e->getMessage(); - } - - echo $output; - - // Display the Profiler's report if the stars are aligned - if ($this->config->pickles['profiler']) - { - Profiler::report(); - } - } - - // @todo Document me - private function validateTemplates(&$module, $parent_template) - { - $templates = [ - SITE_TEMPLATE_PATH . '__shared/' . $parent_template . '.phtml', - SITE_TEMPLATE_PATH . $_REQUEST['request'] . '.phtml', - ]; - - $module->template = []; - $child_exists = file_exists($templates[1]); - - if (file_exists($templates[0]) && $child_exists) - { - $module->template = $templates; - return true; - } - elseif ($child_exists) - { - $module->template = [$templates[1]]; - return true; - } - - return false; - } -} - diff --git a/src/classes/Convert.php b/src/classes/Convert.php deleted file mode 100644 index 4261c03..0000000 --- a/src/classes/Convert.php +++ /dev/null @@ -1,122 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Convert Class - * - * Collection of statically called methods to help aid in converting data - * formats. - */ -class Convert -{ - // {{{ Array to XML - - /** - * Array to XML - * - * Converts an array into XML tags (recursive). This method expects the - * passed array to be formatted very specifically to accomodate the fact - * that an array's format isn't quite the same as well-formed XML. - * - * Input Array = - * ['children' => [ - * 'child' => [ - * ['name' => 'Wendy Darling'], - * ['name' => 'John Darling'], - * ['name' => 'Michael Darling'], - * ], - * ]] - * - * Output XML = - * - * Wendy Darling - * John Darling - * Michael Darling - * - * - * @static - * @param array $array array to convert into XML - * @return string generated XML - */ - public static function arrayToXML($array, $format = false, $level = 0) - { - $xml = ''; - - if (is_array($array)) - { - foreach ($array as $node => $value) - { - // Checks if the value is an array - if (is_array($value)) - { - foreach ($value as $node2 => $value2) - { - if (is_array($value2)) - { - // Nest the value if the node is an integer - $new_value = (is_int($node2) ? $value2 : [$node2 => $value2]); - - $xml .= ($format ? str_repeat("\t", $level) : ''); - $xml .= '<' . $node . '>' . ($format ? "\n" : ''); - $xml .= self::arrayToXML($new_value, $format, $level + 1); - $xml .= ($format ? str_repeat("\t", $level) : ''); - $xml .= '' . ($format ? "\n" : ''); - } - else - { - if (is_int($node2)) - { - $node2 = $node; - } - - // Checks for special characters - if (htmlspecialchars($value2) != $value2) - { - $xml .= ($format ? str_repeat("\t", $level) : ''); - $xml .= '<' . $node2 . '>' . ($format ? "\n" : ''); - } - else - { - $xml .= ($format ? str_repeat("\t", $level) : ''); - $xml .= '<' . $node2 . '>' . $value2 . '' . ($format ? "\n" : ''); - } - } - } - } - else - { - // Checks for special characters - if (htmlspecialchars($value) != $value) - { - $xml .= ($format ? str_repeat("\t", $level) : ''); - $xml .= '<' . $node . '>' . ($format ? "\n" : ''); - } - else - { - $xml .= ($format ? str_repeat("\t", $level) : ''); - $xml .= '<' . $node . '>' . $value . '' . ($format ? "\n" : ''); - } - } - } - } - - return $xml; - } - - // }}} -} - diff --git a/src/classes/Database.php b/src/classes/Database.php deleted file mode 100644 index 82028fa..0000000 --- a/src/classes/Database.php +++ /dev/null @@ -1,420 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - * @todo Drop driver, hardcode drivers based on the type - * @todo More assumptions for the datasource variables - */ - -/** - * Database Class - * - * Database interaction all in one place. Allows for object reuse and contains - * functions to ease interacting with databases. Common assumptions about PDO - * attributes are baked in. Only support PDO. - */ -class Database extends Object -{ - /** - * DSN format - * - * @access protected - * @var string - */ - protected $dsn; - - /** - * PDO Attributes - * - * @access protected - * @var string - */ - protected $attributes = [ - PDO::ATTR_PERSISTENT => true, - PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION, - PDO::NULL_EMPTY_STRING => true, - ]; - - /** - * Driver - * - * @var string - */ - public $driver = null; - - /** - * Hostname for the server - * - * @var string - */ - public $hostname = 'localhost'; - - /** - * Port number for the server - * - * @var integer - */ - public $port = null; - - /** - * UNIX socket for the server - * - * @var integer - */ - public $socket = null; - - /** - * Username for the server - * - * @var string - */ - public $username = null; - - /** - * Password for the server - * - * @var string - */ - public $password = null; - - /** - * Database name for the server - * - * @var string - */ - public $database = null; - - /** - * Whether or not to use caching - * - * @var boolean - */ - public $cache = false; - - /** - * Connection resource - * - * @var object - */ - public $connection = null; - - /** - * Results object for the executed statement - * - * @var object - */ - public $results = null; - - /** - * Get Instance - * - * Instantiates a new instance of the Database class or returns the - * previously instantiated copy. - * - * @static - * @param string $datasource_name name of the datasource - * @return object instance of the class - */ - public static function getInstance($datasource_name = false) - { - $config = Config::getInstance(); - - // Tries to load a datasource if one wasn't specified - if (!$datasource_name) - { - if (isset($config->pickles['datasource'])) - { - $datasource_name = $config->pickles['datasource']; - } - elseif (is_array($config->datasources)) - { - $datasources = $config->datasources; - - foreach ($datasources as $name => $datasource) - { - if (isset($datasource['driver'])) - { - $datasource_name = $name; - } - } - } - } - - // Attempts to validate the datasource - if ($datasource_name) - { - if (!isset(self::$instances['Database'][$datasource_name])) - { - if (!isset($config->datasources[$datasource_name])) - { - throw new Exception('The specified datasource is not defined in the config.'); - } - - $datasource = $config->datasources[$datasource_name]; - - if (!isset($datasource['driver'])) - { - throw new Exception('The specified datasource lacks a driver.'); - } - - $datasource['driver'] = strtolower($datasource['driver']); - - // Checks the driver is legit and scrubs the name - switch ($datasource['driver']) - { - case 'pdo_mysql': - $attributes = [ - 'dsn' => 'mysql:host=[[hostname]];port=[[port]];unix_socket=[[socket]];dbname=[[database]]', - 'port' => 3306, - ]; - break; - - case 'pdo_pgsql': - $attributes = [ - 'dsn' => 'pgsql:host=[[hostname]];port=[[port]];dbname=[[database]];user=[[username]];password=[[password]]', - 'port' => 5432, - ]; - break; - - case 'pdo_sqlite': - $attributes = ['dsn' => 'sqlite:[[hostname]]']; - break; - - default: - throw new Exception('Datasource driver "' . $datasource['driver'] . '" is invalid'); - break; - } - - // Instantiates our database class - $instance = new Database(); - - // Sets our database parameters - if (is_array($datasource)) - { - $datasource = array_merge($attributes, $datasource); - - foreach ($datasource as $variable => $value) - { - $instance->$variable = $value; - } - } - - // Caches the instance for possible reuse later - self::$instances['Database'][$datasource_name] = $instance; - } - - // Returns the instance - return self::$instances['Database'][$datasource_name]; - } - - return false; - } - - /** - * Opens database connection - * - * Establishes a connection to the database based on the set configuration - * options. - * - * @return boolean true on success, throws an exception overwise - */ - public function open() - { - if ($this->connection === null) - { - switch ($this->driver) - { - case 'pdo_mysql': - // Resolves "Invalid UTF-8 sequence" issues when encoding as JSON - // @todo Didn't resolve that issue, borked some other characters though - //$this->attributes[PDO::MYSQL_ATTR_INIT_COMMAND] = 'SET NAMES utf8'; - break; - - case 'pdo_pgsql': - // This combats a bug: https://bugs.php.net/bug.php?id=62571&edit=1 - $this->attributes[PDO::ATTR_PERSISTENT] = false; - - // This allows for multiple prepared queries - $this->attributes[PDO::ATTR_EMULATE_PREPARES] = true; - break; - } - - if (isset($this->username, $this->password, $this->database)) - { - // Swaps out any variables with values in the DSN - $this->dsn = str_replace( - ['[[hostname]]', '[[port]]', '[[socket]]', '[[username]]', '[[password]]', '[[database]]'], - [$this->hostname, $this->port, $this->socket, $this->username, $this->password, $this->database], - $this->dsn - ); - - // Strips any empty parameters in the DSN - $this->dsn = str_replace(['host=;', 'port=;', 'unix_socket=;'], '', $this->dsn); - - // Attempts to establish a connection - $this->connection = new PDO($this->dsn, $this->username, $this->password, $this->attributes); - } - else - { - throw new Exception('There was an error loading the database configuration.'); - } - } - - return true; - } - - /** - * Closes database connection - * - * Sets the connection to null regardless of state. - * - * @return boolean always true - */ - public function close() - { - $this->connection = null; - return true; - } - - /** - * Executes an SQL Statement - * - * Executes a standard or prepared query based on passed parameters. All - * queries are logged to a file as well as timed and logged in the - * execution time is over 1 second. - * - * @param string $sql statement to execute - * @param array $input_parameters optional key/values to be bound - * @param boolean $force_slow optional, force slow query logging - * @return integer ID of the last inserted row or sequence number - */ - public function execute($sql, $input_parameters = null, $force_slow = false) - { - $this->open(); - - if (isset($this->config->pickles['logging']) && $this->config->pickles['logging']) - { - $loggable_query = $sql; - - if ($input_parameters != null) - { - $loggable_query .= ' -- ' . json_encode($input_parameters); - } - - Log::query($loggable_query); - } - - $sql = trim($sql); - - // Checks if the query is blank - if ($sql != '') - { - // Builds out stack trace for queries - $files = []; - - $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); - krsort($backtrace); - - foreach ($backtrace as $file) - { - if (isset($file['class'], $file['line'])) - { - $files[] = $file['class'] . ':' . $file['line']; - } - } - - $sql .= "\n" . '/* [' . implode('|', $files) . '] */'; - - // Establishes if we're working on an EXPLAIN - if (Profiler::enabled('explains')) - { - $explain = preg_match('/^SELECT /i', $sql); - } - else - { - $explain = null; - } - - // Executes a standard query - if ($input_parameters === null) - { - // Explains the query - if ($explain) - { - $explain = $this->fetch('EXPLAIN ' . $sql); - } - - $start_time = microtime(true); - $this->results = $this->connection->query($sql); - } - // Executes a prepared statement - else - { - // Explains the query - if ($explain) - { - $explain = $this->fetch('EXPLAIN ' . $sql, $input_parameters); - } - - $start_time = microtime(true); - $this->results = $this->connection->prepare($sql); - $this->results->execute($input_parameters); - } - - $end_time = microtime(true); - $duration = $end_time - $start_time; - - if ($duration >= 1 || $force_slow) - { - Log::slowQuery($duration . ' seconds: ' . $loggable_query); - } - - // Logs the information to the profiler - if (Profiler::enabled('explains', 'queries')) - { - Profiler::logQuery($sql, $input_parameters, (isset($explain) ? $explain : false), $duration); - } - } - else - { - throw new Exception('No query to execute.'); - } - - return $this->connection->lastInsertId(); - } - - /** - * Fetch records from the database - * - * @param string $sql statement to be executed - * @param array $input_parameters optional key/values to be bound - * @param string $return_type optional type of return set - * @return mixed based on return type - */ - public function fetch($sql = null, $input_parameters = null) - { - $this->open(); - - if ($sql !== null) - { - $this->execute($sql, $input_parameters); - } - - // Pulls the results based on the type - $results = $this->results->fetchAll(PDO::FETCH_ASSOC); - - return $results; - } -} - diff --git a/src/classes/Date.php b/src/classes/Date.php deleted file mode 100644 index 6168a26..0000000 --- a/src/classes/Date.php +++ /dev/null @@ -1,40 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Date Class - * - * Just a simple collection of static functions to accomplish some of the more - * redundant date related manipulation. - */ -class Date -{ - /** - * Age - * - * Calculates age based on the passed date. - * - * @static - * @param string $date birth / inception date - * @return integer $age number of years old - */ - public static function age($date) - { - return Time::age($date); - } -} - diff --git a/src/classes/Display.php b/src/classes/Display.php deleted file mode 100644 index eca2628..0000000 --- a/src/classes/Display.php +++ /dev/null @@ -1,204 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Display Class - * - * If you can see it then it probably happened in here. - */ -class Display extends Object -{ - /** - * Return Type - * - * This class supports loading a PHP template, displaying JSON, XML and an - * RSS flavored XML. Inside your modules you can specify either a string or - * array. Possible values include "template", "json", "xml" and "rss". - * Default behavior is to try to load a template and fallback to displaying - * JSON. The "template" option always takes precedence when used with the - * other types. - * - * @var mixed string or array to determine how to return - */ - public $return = ['template', 'json']; - - /** - * Templates - * - * Templates are found in the ./templates directory of your site. The - * template workflow is to load ./templates/__shared/index.phtml and you - * would set that template up to require $this->template, the path and - * filename for the module template (named based on the structure of the - * requested URI. Inside your module you can specify the basename of the - * parent template you would like to use or false to not use a parent - * template. - * - * @var string or boolean false the basename of the parent template - */ - public $templates = false; - - /** - * Meta Data - * - * An array of meta data that you want exposed to the template. Currently - * you set the meta data from inside your module using the class variables - * title, description and keywords. The newer [preferred] method is to - * set an array in your module using the meta variable using title, - * description and keywords as the keys. You can also specify any other - * meta keys in the array that you would like to be exposed to your - * templates. The meta data is only used by TEMPLATE and RSS return types. - */ - public $meta = []; - - /** - * Module Data - * - * Any data the module returns or is assigned inside of the module will - * be available here and exposed to the template. - */ - public $module = null; - - public function render() - { - try - { - // Starts up the buffer so we can capture it - ob_start(); - - if (!is_array($this->return)) - { - $this->return = [$this->return]; - } - - $return_json = $return_rss = $return_template = $return_xml = false; - - foreach ($this->return as $return) - { - $variable = 'return_' . $return; - $$variable = true; - } - - // Makes sure the return type is valid - if (!$return_json && !$return_rss && !$return_template && !$return_xml) - { - throw new Exception('Invalid return type.'); - } - - // Checks for the PHPSESSID in the query string - if (stripos($_SERVER['REQUEST_URI'], '?PHPSESSID=') === false) - { - // XHTML compliancy stuff - // @todo Wonder if this could be yanked now that we're in HTML5 land - ini_set('arg_separator.output', '&'); - ini_set('url_rewriter.tags', 'a=href,area=href,frame=src,input=src,fieldset='); - - header('Content-type: text/html; charset=UTF-8'); - } - else - { - // Redirect so Google knows to index the page without the session ID - list($request_uri, $phpsessid) = explode('?PHPSESSID=', $_SERVER['REQUEST_URI'], 2); - header('HTTP/1.1 301 Moved Permanently'); - header('Location: ' . $request_uri); - - throw new Exception('Requested URI contains PHPSESSID, redirecting.'); - } - - // @todo Derrive CSS and JS from _REQUEST['request'] no need to pass around - - $loaded = false; - - if ($return_template) - { - // Determines if we're using a custom class or not - $dynamic_class = (class_exists('CustomDynamic') ? 'CustomDynamic' : 'Dynamic'); - $form_class = (class_exists('CustomForm') ? 'CustomForm' : 'Form'); - $html_class = (class_exists('CustomHTML') ? 'CustomHTML' : 'HTML'); - - // Exposes some objects and variables to the local scope of the template - $this->request = $this->js_file = $_REQUEST['request']; - // @todo replace _ with - as it's more appropriate for CSS naming - $this->css_class = strtr($this->request, '/', '_'); - - // @todo Remove the magic $__variable when all sites are ported - $__config = $this->config; - $__css_class = $this->css_class; - $__js_file = $this->js_file; - $__meta = $this->meta; - $__module = $this->module; - - $__dynamic = $this->dynamic = new $dynamic_class(); - $__form = $this->form = new $form_class(); - $__html = $this->html = new $html_class(); - - // Checks for the parent template and tries to load it - if ($this->templates) - { - $profiler = $this->config->pickles['profiler']; - $profiler = $profiler === true || stripos($profiler, 'timers') !== false; - - // Starts a timer for the loading of the template - if ($profiler) - { - Profiler::timer('loading template'); - } - - // Assigns old variable - $required_template = $this->templates[0]; - $__template = $this->template = end($this->templates); - $loaded = require_once $required_template; - - // Stops the template loading timer - if ($profiler) - { - Profiler::timer('loading template'); - } - } - } - - if (!$loaded) - { - if ($return_json) - { - $pretty = isset($_REQUEST['pretty']) ? JSON_PRETTY_PRINT : false; - echo json_encode($this->module, $pretty); - } - elseif ($return_xml) - { - echo Convert::arrayToXML($this->module, isset($_REQUEST['pretty'])); - } - } - - // Grabs the buffer so we can massage it a bit - $buffer = ob_get_clean(); - - // Kills any whitespace and HTML comments in templates - if ($loaded) - { - // The BSA exception is because their system sucks and demands there be comments present - $buffer = preg_replace(['/^[\s]+/m', '//U'], '', $buffer); - } - - return $buffer; - } - catch (Exception $e) - { - return $e->getMessage(); - } - } -} - diff --git a/src/classes/Distance.php b/src/classes/Distance.php deleted file mode 100644 index d079228..0000000 --- a/src/classes/Distance.php +++ /dev/null @@ -1,143 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Distance Class - * - * Collection of statically called methods to help aid distance-related - * conversions and calculations. - */ -class Distance -{ - // {{{ Call Static - - /** - * Call Static - * - * Magic method to power the unit conversion without much code. - * - * @static - * @param string $method name of the static method being called - * @param array $arguments array of the passed arguments - * @return mixed converted units or false - */ - public static function __callStatic($method, $arguments) - { - $pieces = explode('to', strtolower($method)); - - if (count($pieces) == 2 && $pieces[1]) - { - return Distance::convertUnit($arguments[0], $pieces[0], $pieces[1]); - } - - return false; - } - - // }}} - // {{{ Convert Unit - - /** - * Convert Unit - * - * Converts a distance from one unit to another. - * - * @static - * @param mixed $distance starting distance - * @param string $from starting unit - * @param string $to ending unit - * @return mixed - */ - private static function convertUnit($distance, $from, $to) - { - $multiplier = 1; - - switch ($from) - { - case 'kilometers': - switch ($to) - { - case 'miles': $multiplier = 0.621371; break; - case 'meters': $multiplier = 1000; break; - case 'yards': $multiplier = 1093.61; break; - } - break; - - case 'miles': - switch ($to) - { - case 'kilometers': $multiplier = 1.60934; break; - case 'meters': $multiplier = 1609.34; break; - case 'yards': $multiplier = 1760; break; - } - break; - - case 'meters': - switch ($to) - { - case 'kilometers': $multiplier = 0.001; break; - case 'miles': $multiplier = 0.000621371; break; - case 'yards': $multiplier = 1.09361; break; - } - break; - } - - return $distance * $multiplier; - } - - // }}} - // {{{ Calculate Distance - - /** - * Calculate Distance - * - * Calculates the distance between two sets of coordinates and returns the - * requested units. I really wanted to call this distance() but it seems - * you can't do that in PHP due to the backwards compatibility of the - * PHP4 constructors that were named the same as the class. - * - * @static - * @param mixed $latitude_from starting latitude - * @param mixed $longitude_from starting longitude - * @param mixed $latitude_to ending latitude - * @param mixed $longitude_to ending longitude - * @param string $unit optional units to return, miles by default - * @return mixed distance between the points in the desired unit - */ - public static function calculateDistance($latitude_from, $longitude_from, $latitude_to, $longitude_to, $unit = 'miles') - { - $unit = ucwords(strtolower($unit)); - $theta = $longitude_from - $longitude_to; - - $distance = - sin(deg2rad($latitude_from)) - * sin(deg2rad($latitude_to)) - + cos(deg2rad($latitude_from)) - * cos(deg2rad($latitude_to)) - * cos(deg2rad($theta)); - - $distance = acos($distance); - $distance = rad2deg($distance); - $miles = $distance * 60 * 1.1515; - - $method = 'milesTo' . $unit; - - return Distance::$method($miles); - } - - // }}} -} - diff --git a/src/classes/Dynamic.php b/src/classes/Dynamic.php deleted file mode 100644 index 2880abb..0000000 --- a/src/classes/Dynamic.php +++ /dev/null @@ -1,99 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Dynamic Class - * - * Handles generating links to static content that are a timestamp injected as - * to avoid hard caching. Also minifies content where applicable. - * - * Note: you will want to add a mod_rewrite line to your .htaccess to support - * the routing to the filenames with the timestamp injected: - * - * RewriteRule ^(.+)\.([\d]+)\.(css|js|gif|png|jpg|jpeg)$ /$1.$3 [NC,QSA] - */ -class Dynamic extends Object -{ - /** - * Generate Reference - * - * Appends a dynamic piece of information to the passed reference in the - * form of a UNIX timestamp added to the query string. - * - * @param string $reference URI reference of the file - * @param string $failover URI reference to use if the reference can't be found - * @return string URI reference reference with dynamic content - */ - public function reference($reference, $failover = false) - { - // Checks if the URI reference is absolute, and not relative - if (substr($reference, 0, 1) == '/') - { - $query_string = ''; - - // Checks for ? and extracts query string - if (strstr($reference, '?')) - { - list($reference, $query_string) = explode('?', $reference); - } - - // Adds the dot so the file functions can find the file - $file = '.' . $reference; - - if (file_exists($file)) - { - // Replaces the extension with time().extension - $parts = explode('.', $reference); - - if (count($parts) == 1) - { - throw new Exception('Filename must have an extension (e.g. /path/to/file.png)'); - } - else - { - end($parts); - $parts[key($parts)] = filemtime($file) . '.' . current($parts); - $reference = implode('.', $parts); - } - - // Adds the query string back - if ($query_string != '') - { - $reference .= '?' . $query_string; - } - } - else - { - if ($failover != false) - { - $reference = $failover; - } - else - { - throw new Exception('Supplied reference does not exist (' . $reference . ')'); - } - } - } - else - { - throw new Exception('Reference value must be absolute (e.g. /path/to/file.png)'); - } - - return $reference; - } -} - diff --git a/src/classes/File.php b/src/classes/File.php deleted file mode 100644 index 585303f..0000000 --- a/src/classes/File.php +++ /dev/null @@ -1,73 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * File Class - * - * Just a simple collection of static functions to accomplish some of the more - * redundant file related manipulation. - */ -class File -{ - /** - * Remove a Directory, Recursively - * - * Removes a directory by emptying all of the contents recursively and then - * removing the directory, as PHP will not let you rmdir() on ain non-empty - * directory. Use with caution, seriously. - * - * @static - * @param string $directory directory to remove - * @return boolean status of the final rmdir(); - */ - public static function removeDirectory($directory) - { - if (substr($directory, -1) != '/') - { - $directory .= '/'; - } - - // If directory is a directory, read in all the files - if (is_dir($directory)) - { - $files = scandir($directory); - - // Loop through said files, check for directories, and unlink files - foreach ($files as $file) - { - if (!in_array($file, ['.', '..'])) - { - if (is_dir($directory . $file)) - { - File::removeDirectory($directory . $file); - } - else - { - unlink($directory . $file); - } - } - } - - rmdir($directory); - } - else - { - unlink($directory); - } - } -} - diff --git a/src/classes/Form.php b/src/classes/Form.php deleted file mode 100644 index 100a162..0000000 --- a/src/classes/Form.php +++ /dev/null @@ -1,672 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Form Class - * - * This class contains methods for easily generating form elements. There is a - * heavy focus on select boxes as they have the most overhead for a developer. - * - * @deprecated - */ -class Form extends Object -{ - // {{{ Get Instance - - /** - * Get Instance - * - * Gets an instance of the Form class - * - * @static - * @param string $class name of the class to get an instance of - * @return object instance of the class - */ - public static function getInstance($class = 'Form') - { - return parent::getInstance($class); - } - - // }}} - // {{{ Input - - /** - * Input - * - * Generates an input with the passed data. - * - * @param string $name name (and ID) for the element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @param string $type optional type of input - * @param boolean $checked optional whether the input is checked - * @return string HTML for the input - */ - public function input($name, $value = null, $classes = null, $additional = null, $type = 'text', $checked = false) - { - if ($additional) - { - $additional = ' ' . $additional; - } - - if (in_array($type, ['checkbox', 'radio']) && $checked == true) - { - $additional .= ' checked="checked"'; - } - - if ($value) - { - $additional .= ' value="' . $value . '"'; - } - - if ($classes) - { - $additional .= ' class="' . $classes . '"'; - } - - return ''; - } - - // }}} - // {{{ Hidden - - /** - * Hidden - * - * Shorthand method to generate a hidden input. - * - * @param string $name name (and ID) for the element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function hidden($name, $value = null, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'hidden'); - } - - /** - * Hidden Input - * - * Shorthand method to generate a hidden input. - * - * @deprecated Use hidden() instead - * - * @param string $name name (and ID) for the element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function hiddenInput($name, $value = null, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'hidden'); - } - - // }}} - // {{{ Password - - /** - * Password - * - * Shorthand method to generate a password input. - * - * @param string $name name (and ID) for the element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function password($name, $value = null, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'password'); - } - - /** - * Password Input - * - * Shorthand method to generate a password input. - * - * @deprecated Use password() instead - * - * @param string $name name (and ID) for the element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function passwordInput($name, $value = null, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'password'); - } - - // }}} - // {{{ Submit - - /** - * Submit - * - * Shorthand method to generate a submit input (button). - * - * @param string $name name (and ID) for the input element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function submit($name, $value = null, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'submit'); - } - - /** - * Submit Input - * - * Shorthand method to generate a submit input (button). - * - * @deprecated Use submit() instead - * - * @param string $name name (and ID) for the input element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function submitInput($name, $value = null, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'submit'); - } - - // }}} - // {{{ Security - - /** - * Security - * - * Generates a hidden input with an SHA1 hash as the value. The name of the - * field is cannot be changed as this method was only intended for use with - * forms that are submitted via AJAX to provide better security. - * - * @param string $value value to hash - * @return string HTML for the input - */ - public function security($value) - { - // Returns the hidden input - return $this->hiddenInput('security_hash', Security::generateHash($value)); - } - - /** - * Security Input - * - * Generates a hidden input with an SHA1 hash as the value. The name of the - * field is cannot be changed as this method was only intended for use with - * forms that are submitted via AJAX to provide better security. - * - * @deprecated Use security() instead - * - * @param string $value value to hash - * @return string HTML for the input - */ - public function securityInput($value) - { - // Returns the hidden input - return $this->hiddenInput('security_hash', Security::generateHash($value)); - } - - // }}} - // {{{ Checkbox - - /** - * Checkbox - * - * Generates a checkbox input with the passed data. - * - * @param string $name name (and ID) for the select element - * @param string $value optional preset value - * @param boolean $checked optional whether the checkbox is checked - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function checkbox($name, $value = null, $checked = false, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'checkbox', $checked); - } - - // }}} - // {{{ Radio Button - - /** - * Radio Button - * - * Generates a radio input with the passed data. - * - * @param string $name name (and ID) for the select element - * @param string $value optional preset value - * @param boolean $checked optional whether the checkbox is checked - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the input - */ - public function radio($name, $value = null, $checked = false, $classes = null, $additional = null) - { - return $this->input($name, $value, $classes, $additional, 'radio', $checked); - } - - // }}} - // {{{ Textarea - - /** - * Textarea - * - * Generates a textarea with the passed data. - * - * @param string $name name (and ID) for the select element - * @param string $value optional preset value - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @param string $type optional type of input - * @return string HTML for the input - */ - public function textarea($name, $value = null, $classes = null, $additional = null) - { - if ($additional) - { - $additional = ' ' . $additional; - } - - if ($classes) - { - $additional .= ' class="' . $classes . '"'; - } - - return ''; - } - - // }}} - // {{{ Select - - /** - * Select - * - * Generates a select box with the passed data. - * - * @param string $name name (and ID) for the select element - * @param array $options key/values for the option elements - * @param string $selected optional selected option - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the select box - */ - public function select($name, $options, $selected = null, $classes = null, $additional = null) - { - if ($additional) - { - $additional = ' ' . $additional; - } - - if ($classes) - { - $additional .= ' class="' . $classes . '"'; - } - - return ''; - } - - // }}} - // {{{ Options - - /** - * Options - * - * Generates the option elements from the passed array - * - * @param array $options key/values for the options - * @param string $selected optional default option - * @return string HTML for the options - */ - public function options($options, $selected = null) - { - $found_selected = false; - $options_html = ''; - - if (is_array($options)) - { - foreach ($options as $main_key => $main_label) - { - if (is_array($main_label)) - { - $options_html .= ''; - - foreach ($main_label as $sub_key => $sub_label) - { - $selected_attribute = false; - if ($selected !== null && $found_selected === false) - { - if ($selected == $sub_key) - { - $selected_attribute = ' selected="selected"'; - $found_selected = true; - } - } - - $options_html .= ''; - } - - $options_html .= ''; - } - else - { - $selected_attribute = false; - if ($selected !== null && $found_selected === false) - { - if ($selected == $main_key) - { - $selected_attribute = ' selected="selected"'; - $found_selected = true; - } - } - - $options_html .= ''; - } - } - } - - if ($selected !== null && $found_selected === false) - { - $options_html .= ''; - } - - return $options_html; - } - - // }}} - // {{{ State Select - - /** - * State Select - * - * Generates a select box with the United States, Puerto Rico and miliary - * options - * - * @param string $name optional name (and ID) for the select element - * @param string $selected optional selected option - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the select box - */ - public function stateSelect($name = 'state', $selected = null, $classes = null, $additional = null) - { - $options = [ - null => '-- Select State --', - 'AK' => 'Alaska', - 'AL' => 'Alabama', - 'AS' => 'American Samoa', - 'AZ' => 'Arizona', - 'AR' => 'Arkansas', - 'CA' => 'California', - 'CO' => 'Colorado', - 'CT' => 'Connecticut', - 'DE' => 'Delaware', - 'DC' => 'District of Columbia', - 'FL' => 'Florida', - 'GA' => 'Georgia', - 'GU' => 'Guam', - 'HI' => 'Hawaii', - 'ID' => 'Idaho', - 'IL' => 'Illinois', - 'IN' => 'Indiana', - 'IA' => 'Iowa', - 'KS' => 'Kansas', - 'KY' => 'Kentucky', - 'LA' => 'Louisiana', - 'ME' => 'Maine', - 'MH' => 'Marshall Islands', - 'MD' => 'Maryland', - 'MA' => 'Massachusetts', - 'MI' => 'Michigan', - 'MN' => 'Minnesota', - 'MS' => 'Mississippi', - 'MO' => 'Missouri', - 'MT' => 'Montana', - 'NE' => 'Nebraska', - 'NV' => 'Nevada', - 'NH' => 'New Hampshire', - 'NJ' => 'New Jersey', - 'NM' => 'New Mexico', - 'NY' => 'New York', - 'NC' => 'North Carolina', - 'ND' => 'North Dakota', - 'MP' => 'Northern Mariana Islands', - 'OH' => 'Ohio', - 'OK' => 'Oklahoma', - 'OR' => 'Oregon', - 'PW' => 'Palau', - 'PA' => 'Pennsylvania', - 'PR' => 'Puerto Rico', - 'RI' => 'Rhode Island', - 'SC' => 'South Carolina', - 'SD' => 'South Dakota', - 'TN' => 'Tennessee', - 'TX' => 'Texas', - 'UT' => 'Utah', - 'VT' => 'Vermont', - 'VI' => 'Virgin Islands', - 'VA' => 'Virginia', - 'WA' => 'Washington', - 'WV' => 'West Virginia', - 'WI' => 'Wisconsin', - 'WY' => 'Wyoming', - 'AE' => 'Armed Forces Africa', - 'AA' => 'Armed Forces Americas (except Canada)', - 'AE' => 'Armed Forces Canada', - 'AE' => 'Armed Forces Europe', - 'AE' => 'Armed Forces Middle East', - 'AP' => 'Armed Forces Pacific' - ]; - - return $this->select($name, $options, $selected, $classes, $additional); - } - - // }}} - // {{{ Date Select - - /** - * Date Select - * - * Generates 3 select boxes (month, day, year) - * - * @param string $name optional name (and ID) for the select element - * @param string $selected optional selected option - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @param integer $start_year optional first year to display - * @param integer $end_year optional last year to display - * @return string HTML for the select boxes - */ - public function dateSelect($name = 'date', $selected = null, $classes = null, $additional = null, $start_year = null, $end_year = null) - { - $html = ''; - - // Breaks apart the selected value if present - if ($selected == null || $selected == '0000-00-00') - { - $selected_month = null; - $selected_day = null; - $selected_year = null; - } - else - { - list($selected_year, $selected_month, $selected_day) = explode('-', $selected); - } - - $month_options = [ - null => 'Month', - '01' => 'January', - '02' => 'February', - '03' => 'March', - '04' => 'April', - '05' => 'May', - '06' => 'June', - '07' => 'July', - '08' => 'August', - '09' => 'September', - '10' => 'October', - '11' => 'November', - '12' => 'December', - ]; - - $day_options = [null => 'Day']; - $year_options = [null => 'Year']; - - // Generates the list of days - for ($i = 1; $i <= 31; ++$i) - { - $day_options[str_pad($i, 2, '0', STR_PAD_LEFT)] = $i; - } - - // Generates the list of years - $current_year = date('Y'); - $start_year = $start_year == null ? $current_year - 10 : $start_year; - $end_year = $end_year == null ? $current_year + 10 : $end_year; - - for ($i = $start_year; $i >= $end_year; --$i) - { - $year_options[$i] = $i; - } - - // Loops through and generates the selects - foreach (['month', 'day', 'year'] as $part) - { - $options = $part . '_options'; - $selected = 'selected_' . $part; - $html .= ($html == '' ? '' : ' ') . $this->select($name . '[' . $part . ']', $$options, $$selected, $classes, $additional); - } - - return $html; - } - - // }}} - // {{{ Date of Birth Select - - /** - * Date of Birth Select - * - * Generates 3 select boxes (month, day, year) - * - * @param string $name optional name (and ID) for the select element - * @param string $selected optional selected option - * @param string $classes optional class names - * @param string $additional optional additional parameters - * @return string HTML for the select boxes - */ - public function dobSelect($name = 'dob', $selected = null, $classes = null, $additional = null) - { - // Note: Start year based on oldest living person: http://en.wikipedia.org/wiki/Oldest_people as of November 2010 - // Note: Start and end year may seem backwards, but we want them in descending order when rendered - return $this->dateSelect($name, $selected, $classes, $additional, date('Y'), 1896); - } - - // }}} - // {{{ Polar Select - - /** - * Polar Select - * - * Generates a polar (yes / no) select box. - * - * @param string $name optional name (and ID) for the select element - * @param string $selected optional selected option - * @param string $classes optional class names - * @param string $additional optional additional parameters - */ - public function polarSelect($name = 'decision', $selected = 0, $classes = null, $additional = null) - { - $options = [1 => 'Yes', 0 => 'No']; - - return $this->select($name, $options, $selected, $classes, $additional); - } - - // }}} - // {{{ Phone Input - - /** - * Phone Input - * - * Generates 3 inputs for a phone number from the passed values. - * - * @param string $name optional name (and ID) for the input elements - * @param string $value optional existing value - * @param string $classes optional class names - * @param string $additional optional additional parameters - */ - public function phoneInput($name = 'phone', $value = null, $classes = null, $additional = null) - { - if ($value == null) - { - $value = [ - 'area_code' => '', - 'prefix' => '', - 'line_number' => '' - ]; - } - else - { - $value = str_replace('-', '', $value); - $value = [ - 'area_code' => substr($value, 0, 3), - 'prefix' => substr($value, 3, 3), - 'line_number' => substr($value, 6) - ]; - } - - $parts = [ - 'area_code' => 3, - 'prefix' => 3, - 'line_number' => 4 - ]; - - if ($additional) - { - $additional = ' ' . $additional; - } - - $additional .= ' class="digits'; - - if ($classes) - { - $additional .= ' ' . $classes; - } - - $additional .= '"'; - - $html = ''; - foreach ($parts as $part => $size) - { - $html .= ($html != '' ? ' ' : ''); - $html .= ''; - } - - return $html; - } - - // }}} -} - diff --git a/src/classes/HTML.php b/src/classes/HTML.php deleted file mode 100644 index af39b32..0000000 --- a/src/classes/HTML.php +++ /dev/null @@ -1,148 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * HTML Class - * - * This class contains methods for easily generating HTML elements. - */ -class HTML extends Object -{ - private $self_closing = ['br', 'hr', 'img', 'input', 'link', 'meta']; - - public function __call($method, $arguments) - { - $attributes = null; - $contents = null; - - if (isset($arguments[0])) - { - $attributes = $arguments[0]; - } - - if (isset($arguments[1])) - { - $contents = $arguments[1]; - } - - // ->inputType('name', $attributes); - if (preg_match('/^input/', $method) && !isset($attributes['label'])) - { - $type = strtolower(str_replace('input', '', $method)); - - switch ($type) - { - case 'datetimelocal': $type = 'datetime-local'; break; - case '': $type = 'text'; break; - } - - $method = 'input'; - - if (is_array($attributes)) - { - $attributes['type'] = $type; - } - else - { - $attributes = ['type' => $type]; - } - } - - if (is_array($attributes) && isset($attributes['label'])) - { - if (isset($attributes['name'])) - { - $label = $this->label(['for' => $attributes['name']], $attributes['label']); - } - else - { - $label = $this->label($attributes['label']); - } - - unset($attributes['label']); - - return $label . $this->$method($attributes, $contents); - } - else - { - return $this->element($method, $attributes, $contents); - } - } - - // {{{ Get Instance - - /** - * Get Instance - * - * Gets an instance of the Form class - * - * @static - * @param string $class name of the class to get an instance of - * @return object instance of the class - */ - public static function getInstance($class = 'HTML') - { - return parent::getInstance($class); - } - - // }}} - - public function element($element) - { - $attributes = null; - $contents = null; - - foreach (func_get_args() as $key => $value) - { - if ($key && $key < 3) - { - if (is_array($value)) - { - $attributes = $value; - } - elseif ($value) - { - $contents = $value; - } - } - } - - $element = strtolower($element); - $html = '<' . $element; - - if ($attributes) - { - if (is_array($attributes)) - { - foreach ($attributes as $attribute => $value) - { - $html .= ' ' . $attribute . '="' . str_replace('"', '\"', $value) . '"'; - } - } - } - - $html .= '>'; - - if (!in_array($element, $this->self_closing)) - { - $html .= $contents . ''; - } - - return $html; - } -} - diff --git a/src/classes/Log.php b/src/classes/Log.php deleted file mode 100644 index 719e682..0000000 --- a/src/classes/Log.php +++ /dev/null @@ -1,151 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Log Class - * - * Standardized logging methods for ease of reporting. - */ -class Log -{ - /** - * Log Information - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function information($message) - { - return self::write('information', $message); - } - - /** - * Log Warning - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function warning($message) - { - return self::write('warning', $message); - } - - /** - * Log Error - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function error($message) - { - return self::write('error', $message); - } - - /** - * Log Slow Query - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function slowQuery($message) - { - return self::write('slow_query', $message); - } - - /** - * Log Credit Card Transaction - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function transaction($message) - { - return self::write('transaction', $message); - } - - /** - * Log PHP Error - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function phpError($message, $time = false) - { - return self::write('php_error', $message, false, $time); - } - - /** - * Log SQL Query - * - * @static - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - public static function query($message) - { - return self::write('query', $message); - } - - /** - * Write Message to Log File - * - * @static - * @access private - * @param string $message message to log - * @return boolean whether or not the write was successful - */ - private static function write($log_type, $message, $format = true, $time = false) - { - $config = Config::getInstance(); - - if (isset($config->pickles['logging']) && $config->pickles['logging']) - { - $log_path = LOG_PATH . date('Y/m/d/', ($time == false ? time() : $time)); - - if (!file_exists($log_path)) - { - mkdir($log_path, 0755, true); - } - - $log_file = $log_path . $log_type . '.log'; - - $message .= "\n"; - - if ($format == true) - { - $backtrace = debug_backtrace(); - rsort($backtrace); - $frame = $backtrace[strpos($backtrace[0]['file'], 'index.php') === false ? 0 : 1]; - - return file_put_contents($log_file, date('H:i:s') . ' ' . str_replace(getcwd(), '', $frame['file']) . ':' . $frame['line'] . ' ' . $message, FILE_APPEND); - } - else - { - return file_put_contents($log_file, $message, FILE_APPEND); - } - } - - return false; - } -} - diff --git a/src/classes/Model.php b/src/classes/Model.php deleted file mode 100644 index 396cd60..0000000 --- a/src/classes/Model.php +++ /dev/null @@ -1,1560 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Model Class - * - * This is a parent class that all PICKLES data models should be extending. When - * using the class as designed, objects will function as active record pattern - * objects. - */ -class Model extends Object -{ - // {{{ Properties - - /** - * Model Name - * - * @var string - */ - public $model = null; - - /** - * Columns - * - * Mapping of key columns for the table. - * - * @var array - */ - public $columns = null; - - /** - * Whether or not to use cache - * - * @var boolean - */ - public $use_cache = false; - - /** - * SQL Array - * - * @var array - */ - public $sql = []; - - /** - * Input Parameters Array - * - * @var array - */ - public $input_parameters = []; - - /** - * Insert Priority - * - * Defaults to false (normal priority) but can be set to "low" or "high" - * - * @var string - */ - public $priority = false; - - /** - * Delayed Insert - * - * @var boolean - */ - public $delayed = false; - - /** - * Ignore Unique Index - * - * @var boolean - */ - public $ignore = false; - - /** - * Replace instead of Insert/Update? - * - * @var boolean - */ - public $replace = false; - - /** - * Field List - * - * SQL: SELECT - * - * @var mixed, string or array - */ - public $fields = '*'; - - /** - * Table Name - * - * SQL: FROM - * - * @var string - */ - public $table = false; - - /** - * Conditions - * - * SQL: WHERE - * - * @var array - */ - public $conditions = false; - - /** - * Group - * - * SQL: GROUP BY - * - * @var mixed, string or array - */ - public $group = false; - - /** - * Having - * - * SQL: HAVING - * - * @var mixed, string or array - */ - public $having = false; - - /** - * Order - * - * SQL: ORDER BY - * - * @var mixed, string or array - */ - public $order = false; - - /** - * Limit - * - * SQL: LIMIT - * - * @var mixed, integer or array - */ - public $limit = false; - - /** - * Offset - * - * SQL: OFFSET - * - * @var integer - */ - public $offset = false; - - /** - * Query Results - * - * @var array - */ - public $results = null; - - /** - * Index - * - * @var integer - */ - public $index = null; - - /** - * Record - * - * @var array - */ - public $record = null; - - /** - * Records - * - * @var array - */ - public $records = null; - - /** - * Original Record - * - * @var array - */ - public $original = null; - - /** - * Iterate - * - * Used to hold the status during a walk() - * - * @var boolean - */ - public $iterate = false; - - /** - * Snapshot - * - * Snapshot of the object properties - * - * @var array - */ - public $snapshot = []; - - /** - * MySQL? - * - * Whether or not we're using MySQL - * - * @var boolean - */ - public $mysql = false; - - /** - * PostgreSQL? - * - * Whether or not we're using PostgreSQL - * - * @var boolean - */ - public $postgresql = false; - - /** - * Commit Type - * - * Indicates what we want to commit. Defaults to a single row commit, any - * calls to queue() will force the commit to process the queue. - * - * @var string - */ - public $commit_type = 'row'; - - // }}} - // {{{ Class Constructor - - /** - * Constructor - * - * Creates a new (empty) object or populates the record set. - * - * @param mixed $type_or_parameters optional type of query or parameters - * @param array $parameters optional data to create a query from - * @param string $passed_key optional key to use for caching - */ - public function __construct($type_or_parameters = null, $parameters = null, $passed_key = null) - { - // Errors if a table is not set. You're welcome, Geoff. - if ($this->table == false) - { - throw new Exception('You must set the table variable'); - } - - // Runs the parent constructor so we have the config - parent::__construct(['cache', 'db']); - - // Interrogates our database object - $this->use_cache = $this->db->cache; - $this->mysql = ($this->db->driver == 'pdo_mysql'); - $this->postgresql = ($this->db->driver == 'pdo_pgsql'); - - // Grabs the class name to use in our cache keys - $this->model = get_class($this); - - // Default column mapping - $columns = [ - 'id' => 'id', - 'created_at' => 'created_at', - 'created_id' => 'created_id', - 'updated_at' => 'updated_at', - 'updated_id' => 'updated_id', - 'deleted_at' => 'deleted_at', - 'deleted_id' => 'deleted_id', - 'is_deleted' => 'is_deleted', - ]; - - // Sets all but the `id` column to false - if ($this->columns === false) - { - foreach ($columns as $column => $field) - { - if ($column != 'id') - { - $columns[$column] = false; - } - } - } - // Merges the model's columns with the defaults - elseif (is_array($this->columns)) - { - foreach ($this->columns as $column => $field) - { - $columns[$column] = $field; - } - } - - $this->columns = $columns; - - // Takes a snapshot of the [non-object] object properties - foreach ($this as $variable => $value) - { - if (!in_array($variable, ['db', 'cache', 'config', 'snapshot'])) - { - $this->snapshot[$variable] = $value; - } - } - - return $this->execute($type_or_parameters, $parameters, $passed_key); - } - - // }}} - // {{{ Database Execution Methods - - /** - * Execute - * - * Potentially populates the record set from the passed arguments. - * - * @param mixed $type_or_parameters optional type of query or parameters - * @param mixed $parameter_or_key optional data to create query or cache key - * @param string $passed_key optional key to use for caching - */ - public function execute($type_or_parameters = null, $parameters_or_key = null, $passed_key = null) - { - // Resets internal properties - foreach ($this->snapshot as $variable => $value) - { - $this->$variable = $value; - } - - // Builds out the query - if ($type_or_parameters != null) - { - // Loads the parameters into the object - if (is_array($type_or_parameters)) - { - if (is_array($parameters_or_key)) - { - throw new Exception('You cannot pass in 2 query parameter arrays'); - } - - $this->prepareParameters($type_or_parameters); - - if ($this->use_cache - && isset($type_or_parameters['conditions'][$this->columns['id']]) - && count($type_or_parameters) == 1 - && count($type_or_parameters['conditions']) == 1) - { - $cache_keys = []; - $sorted_records = []; - - if (!is_array($type_or_parameters['conditions'][$this->columns['id']])) - { - $type_or_parameters['conditions'][$this->columns['id']] = [$type_or_parameters['conditions'][$this->columns['id']]]; - } - - foreach ($type_or_parameters['conditions'][$this->columns['id']] as $id) - { - $cache_keys[] = strtoupper($this->model) . '-' . $id; - $sorted_records[$id] = true; - } - - $cached = $this->cache->get($cache_keys); - $partial_cache = []; - - if ($cached !== false) - { - foreach ($cached as $record) - { - $partial_cache[$record['id']] = $record; - } - } - - unset($cached); - - foreach ($type_or_parameters['conditions'][$this->columns['id']] as $key => $id) - { - if (isset($partial_cache[$id])) - { - unset($type_or_parameters['conditions'][$this->columns['id']][$key]); - } - } - - if (count($type_or_parameters['conditions'][$this->columns['id']]) == 0) - { - $cache_key = true; - $cached = array_values($partial_cache); - } - } - - if ($this->columns['is_deleted']) - { - $type_or_parameters['conditions'][$this->columns['is_deleted']] = '0'; - } - - $this->loadParameters($type_or_parameters); - } - elseif (is_array($parameters_or_key)) - { - $this->prepareParameters($parameters_or_key); - - // @todo Fix cache merging to allow for this - /* - if ($this->use_cache - && isset($parameters_or_key['conditions'][$this->columns['id']]) - && count($parameters_or_key) == 1 - && count($parameters_or_key['conditions']) == 1) - { - $cache_keys = []; - $sorted_records = []; - - foreach ($parameters_or_key['conditions'][$this->columns['id']] as $id) - { - $cache_keys[] = strtoupper($this->model) . '-' . $id; - $sorted_records[$id] = true; - } - - $cached = $this->cache->get($cache_keys); - $partial_cache = []; - - if ($cached !== false) - { - foreach ($cached as $record) - { - $partial_cache[$record['id']] = $record; - } - } - - unset($cached); - - foreach ($parameters_or_key['conditions'][$this->columns['id']] as $key => $id) - { - if (isset($partial_cache[$id])) - { - unset($parameters_or_key['conditions'][$this->columns['id']][$key]); - } - } - - if (count($parameters_or_key['conditions'][$this->columns['id']]) == 0) - { - $cache_key = true; - $cached = array_values($partial_cache); - } - } - */ - - if ($this->columns['is_deleted']) - { - $parameters_or_key['conditions'][$this->columns['is_deleted']] = '0'; - } - - $this->loadParameters($parameters_or_key); - } - elseif (ctype_digit((string)$type_or_parameters)) - { - $cache_key = strtoupper($this->model) . '-' . $type_or_parameters; - $parameters_or_key = [$this->columns['id'] => $type_or_parameters]; - - if ($this->columns['is_deleted']) - { - $parameters_or_key[$this->columns['is_deleted']] = '0'; - } - - $this->loadParameters($parameters_or_key); - } - elseif (ctype_digit((string)$parameters_or_key)) - { - // @todo Fix cache merging to allow for this - //$cache_key = strtoupper($this->model) . '-' . $parameters_or_key; - - $parameters_or_key = [$this->columns['id'] => $parameters_or_key]; - - if ($this->columns['is_deleted']) - { - $parameters_or_key[$this->columns['is_deleted']] = '0'; - } - - $this->loadParameters($parameters_or_key); - } - elseif ($this->columns['is_deleted']) - { - $this->loadParameters([$this->columns['is_deleted'] => '0']); - } - - if (is_string($passed_key)) - { - $cache_key = $passed_key; - } - - // Starts with a basic SELECT ... FROM - $this->sql = [ - 'SELECT ' . (is_array($this->fields) ? implode(', ', $this->fields) : $this->fields), - 'FROM ' . $this->table, - ]; - - // Updates query to use COUNT syntax - if ($type_or_parameters == 'count') - { - $this->sql[0] = 'SELECT COUNT(*) AS count'; - $this->generateQuery(); - } - // Adds the rest of the query - elseif (!isset($cache_key) || $cache_key !== true) - { - $this->generateQuery(); - } - - if (isset($cache_key) && $this->use_cache && !isset($cached)) - { - $cached = $this->cache->get($cache_key); - } - - if (isset($cached) && $cached !== false) - { - $this->records = $cached; - } - else - { - $this->records = $this->db->fetch( - implode(' ', $this->sql), - (count($this->input_parameters) == 0 ? null : $this->input_parameters) - ); - - if (isset($partial_cache) && count($this->records)) - { - $records = array_merge($partial_cache, $this->records); - - if (isset($sorted_records)) - { - foreach ($records as $record) - { - $sorted_records[$record['id']] = $record; - } - - $records = $sorted_records; - } - - $this->records = $records; - } - - if ($this->use_cache) - { - if (isset($cache_key)) - { - if ($passed_key) - { - $cache_value = $this->records; - } - elseif (isset($this->records[0])) - { - $cache_value = $this->records[0]; - } - - // Only set the value for non-empty records. Caching - // values that are empty could be caused by querying - // records that don't exist at the moment, but could - // exist in the future. INSERTs do not do any sort of - // cache invalidation at this time. - if (isset($cache_value)) - { - $this->cache->set($cache_key, $cache_value); - } - } - elseif (isset($cache_keys)) - { - // @todo Move to Memcached extension and switch to use setMulti() - foreach ($this->records as $record) - { - if (isset($record['id'])) - { - $this->cache->set(strtoupper($this->model) . '-' . $record['id'], $record); - } - } - } - } - } - - $index_records = in_array($type_or_parameters, ['list', 'indexed']); - - // Flattens the data into a list - if ($index_records == true) - { - $list = []; - - foreach ($this->records as $record) - { - // Uses the first value as the key and the second as the value - if ($type_or_parameters == 'list') - { - $list[array_shift($record)] = array_shift($record); - } - // Uses the first value as the key - else - { - $list[current($record)] = $record; - } - } - - $this->records = $list; - } - - // Sets up the current record - if (isset($this->records[0])) - { - $this->record = $this->records[0]; - } - else - { - if ($index_records == true) - { - $this->record[key($this->records)] = current($this->records); - } - else - { - $this->record = $this->records; - } - } - - if (!preg_match('/^[0-9]+$/', implode('', array_keys($this->records)))) - { - $this->records = [$this->records]; - } - - $this->index = 0; - $this->original = $this->records; - } - - return true; - } - - // }}} - // {{{ SQL Generation Methods - - /** - * Generate Query - * - * Goes through all of the object variables that correspond with parts of - * the query and adds them to the master SQL array. - * - * @return array $this->sql an array of SQL parts - */ - public function generateQuery() - { - // Adds the WHERE conditionals - if ($this->conditions != false) - { - $use_id = true; - - foreach ($this->conditions as $column => $value) - { - if (!is_int($column)) - { - $use_id = false; - } - } - - if ($use_id) - { - $this->conditions = [$this->columns['id'] => $this->conditions]; - } - - $this->sql[] = 'WHERE ' . (is_array($this->conditions) ? $this->generateConditions($this->conditions) : $this->conditions); - } - - // Adds the GROUP BY syntax - if ($this->group != false) - { - $this->sql[] = 'GROUP BY ' . (is_array($this->group) ? implode(', ', $this->group) : $this->group); - } - - // Adds the HAVING conditions - if ($this->having != false) - { - $this->sql[] = 'HAVING ' . (is_array($this->having) ? $this->generateConditions($this->having) : $this->having); - } - - // Adds the ORDER BY syntax - if ($this->order != false) - { - $this->sql[] = 'ORDER BY ' . (is_array($this->order) ? implode(', ', $this->order) : $this->order); - } - - // Adds the LIMIT syntax - if ($this->limit != false) - { - $this->sql[] = 'LIMIT ' . (is_array($this->limit) ? implode(', ', $this->limit) : $this->limit); - } - - // Adds the OFFSET syntax - if ($this->offset != false) - { - $this->sql[] = 'OFFSET ' . $this->offset; - } - - return $this->sql; - } - - /** - * Generate Conditions - * - * Generates the conditional blocks of SQL from the passed array of - * conditions. Supports as much as I could remember to implement. This - * method is utilized by both the WHERE and HAVING clauses. - * - * @param array $conditions array of potentially nested conditions - * @param boolean $inject_values whether or not to use input parameters - * @param string $conditional syntax to use between conditions - * @return string $sql generated SQL for the conditions - */ - public function generateConditions($conditions, $inject_values = false, $conditional = 'AND') - { - $sql = ''; - - foreach ($conditions as $key => $value) - { - $key = trim($key); - - if ($sql != '') - { - if (preg_match('/^(AND|&&|OR|\|\||XOR)( NOT)?/i', $key)) - { - $sql .= ' '; - } - else - { - $sql .= ' ' . $conditional . ' '; - } - } - - // Checks for our keywords to control the flow - $operator = preg_match('/(<|<=|=|>=|>|!=|!|<>| LIKE)$/i', $key); - $between = preg_match('/ BETWEEN$/i', $key); - $is_is_not = preg_match('/( IS| IS NOT)$/i', $key); - - // Checks for boolean and null - $is_true = ($value === true); - $is_false = ($value === false); - $is_null = ($value === null); - - // Generates an in statement - if (is_array($value) && $between == false) - { - $sql .= $key . ' in ('; - - if ($inject_values == true) - { - $sql .= implode(', ', $value); - } - else - { - $sql .= implode(', ', array_fill(1, count($value), '?')); - $this->input_parameters = array_merge($this->input_parameters, $value); - } - - $sql .= ')'; - } - else - { - // If the key is numeric it wasn't set, so don't use it - if (is_numeric($key)) - { - $sql .= $value; - } - else - { - // Omits the operator as the operator is there - if ($operator == true || $is_is_not == true) - { - if ($is_true || $is_false || $is_null) - { - // Scrubs the operator if someone doesn't use IS / IS NOT - if ($operator == true) - { - $key = preg_replace('/ ?(!=|!|<>)$/i', ' IS NOT', $key); - $key = preg_replace('/ ?(<|<=|=|>=| LIKE)$/i', ' IS', $key); - } - - $sql .= $key . ' '; - - if ($is_true) - { - $sql .= 'TRUE'; - } - elseif ($is_false) - { - $sql .= 'FALSE'; - } - else - { - $sql .= 'NULL'; - } - } - else - { - $sql .= $key . ' '; - - if ($inject_values == true) - { - $sql .= $value; - } - else - { - $sql .= '?'; - $this->input_parameters[] = $value; - } - } - } - // Generates a between statement - elseif ($between == true) - { - if (is_array($value)) - { - // Checks the number of values, between expects 2 - if (count($value) != 2) - { - throw new Exception('BETWEEN expects an array with 2 values.'); - } - else - { - $sql .= $key . ' '; - - if ($inject_values == true) - { - $sql .= $value[0] . ' AND ' . $value[1]; - } - else - { - $sql .= '? AND ?'; - $this->input_parameters = array_merge($this->input_parameters, $value); - } - } - } - else - { - throw new Exception('BETWEEN expects an array.'); - } - } - else - { - $sql .= $key . ' '; - - // Checks if we're working with constants - if ($is_true) - { - $sql .= 'IS TRUE'; - } - elseif ($is_false) - { - $sql .= 'IS FALSE'; - } - elseif ($is_null) - { - $sql .= 'IS NULL'; - } - else - { - if ($inject_values == true) - { - $sql .= '= ' . $value; - } - else - { - $sql .= '= ?'; - $this->input_parameters[] = $value; - } - } - } - } - } - } - - return $sql; - } - - // }}} - // {{{ Record Interaction Methods - - /** - * Count Records - * - * Counts the records - */ - public function count() - { - if (isset($this->records[0]) && $this->records[0] == []) - { - return 0; - } - else - { - return count($this->records); - } - } - - /** - * Sort Records - * - * Sorts the records by the specified index in the specified order. - * - * @param string $index the index to be sorted on - * @param string $order the direction to order - * @return boolean true - * @todo Implement this method - */ - public function sort($index, $order = 'asc') - { - return true; - } - - /** - * Shuffle Records - * - * Sorts the records in a pseudo-random order. - * - * @return boolean true - * @todo Implement this method - */ - public function shuffle() - { - return true; - } - - /** - * Next Record - * - * Increment the record array to the next member of the record set. - * - * @return boolean whether or not there was next element - */ - public function next() - { - $return = (boolean)($this->record = next($this->records)); - - if ($return == true) - { - $this->index++; - } - - return $return; - } - - /** - * Previous Record - * - * Decrement the record array to the next member of the record set. - * - * @return boolean whether or not there was previous element - */ - public function prev() - { - $return = (boolean)($this->record = prev($this->records)); - - if ($return == true) - { - $this->index--; - } - - return $return; - } - - /** - * Reset Record - * - * Set the pointer to the first element of the record set. - * - * @return boolean whether or not records is an array (and could be reset) - */ - public function reset() - { - $return = (boolean)($this->record = reset($this->records)); - - if ($return == true) - { - $this->index = 0; - } - - return $return; - } - - /** - * First Record - * - * Alias of reset(). "first" is more intuitive to me, but reset stays in - * line with the built in PHP functions. Not sure why I'd want to add some - * consistency to one of the most inconsistent languages. - * - * @return boolean whether or not records is an array (and could be reset) - */ - public function first() - { - return $this->reset(); - } - - /** - * End Record - * - * Set the pointer to the last element of the record set. - * - * @return boolean whether or not records is an array (and end() worked) - */ - public function end() - { - $return = (boolean)($this->record = end($this->records)); - - if ($return == true) - { - $this->index = $this->count() - 1; - } - - return $return; - } - - /** - * Last record - * - * Alias of end(). "last" is more intuitive to me, but end stays in line - * with the built in PHP functions. - * - * @return boolean whether or not records is an array (and end() worked) - */ - public function last() - { - return $this->end(); - } - - /** - * Walk Records - * - * Returns the current record and advances to the next. Built to allow for - * simplified code when looping through a record set. - * - * @return mixed either an array of the current record or false - * @todo does not currently support "indexed" or "list" return types - */ - public function walk() - { - // checks if we should start iterating, solves off by one issues with next() - if ($this->iterate == false) - { - $this->iterate = true; - - // resets the records, saves calling reset() when walking multiple times - $this->reset(); - } - else - { - $this->next(); - } - - return $this->record; - } - - /** - * Queue Record - * - * Stashes the current record and creates an empty record ready to be - * manipulated. Eliminates looping through records and inserting each one - * separately and/or the need for helper methods in the models. - */ - public function queue() - { - $this->commit_type = 'queue'; - $this->records[] = $this->record; - $this->record = null; - } - - // }}} - // {{{ Record Manipulation Methods - - /** - * Commit - * - * INSERTs or UPDATEs a record in the database. - * - * @return boolean results of the query - */ - public function commit() - { - // Multiple row query / queries - if ($this->commit_type == 'queue') - { - $update = false; - $cache_keys = []; - - /** - * @todo I outta loop through twice to determine if it's an INSERT - * or an UPDATE. As it stands, you could run into a scenario - * where you could have a mixed lot that would attempt to - * build out a query with both INSERT and UPDATE syntax and - * would probably cause a doomsday scenario for our universe. - * @todo Doesn't play nice with ->walk() at all. Ends up stuck in - * an infinite loop and never executes. Could be part of the - * aforementioned doomsday scenario and fortunately PHP isn't - * letting it happen thanks to memory constraints. - */ - foreach ($this->records as $record) - { - // Performs an UPDATE with multiple queries - if (array_key_exists($this->columns['id'], $record)) - { - $update = true; - - if (!isset($sql)) - { - $sql = ''; - $input_parameters = []; - } - - $update_fields = []; - - foreach ($record as $field => $value) - { - if ($field != $this->columns['id']) - { - $update_fields[] = $field . ' = ?'; - $input_parameters[] = (is_array($value) ? json_encode($value) : $value); - } - else - { - $cache_keys[] = strtoupper($this->model) . '-' . $value; - } - } - - // @todo Check if the column was passed in - if ($this->columns['updated_at'] != false) - { - $update_fields[] = $this->columns['updated_at'] . ' = ?'; - $input_parameters[] = Time::timestamp(); - } - - // @todo Check if the column was passed in - if ($this->columns['updated_id'] != false && isset($_SESSION['__pickles']['security']['user_id'])) - { - $update_fields[] = $this->columns['updated_id'] . ' = ?'; - $input_parameters[] = $_SESSION['__pickles']['security']['user_id']; - } - - if ($sql != '') - { - $sql .= '; '; - } - - $sql .= 'UPDATE ' . $this->table - . ' SET ' . implode(', ', $update_fields) - . ' WHERE ' . $this->columns['id'] . ' = ?'; - - $input_parameters[] = $record[$this->columns['id']]; - } - // Performs a multiple row INSERT - else - { - if (!isset($sql)) - { - $field_count = count($record); - $insert_fields = array_keys($record); - - if ($this->columns['created_at'] != false) - { - $insert_fields[] = $this->columns['created_at']; - $field_count++; - } - - if ($this->columns['created_id'] != false && isset($_SESSION['__pickles']['security']['user_id'])) - { - $insert_fields[] = $this->columns['created_id']; - $field_count++; - } - - $values = '(' . implode(', ', array_fill(0, $field_count, '?')) . ')'; - $input_parameters = []; - - // INSERT INTO ... - $sql = 'INSERT INTO ' . $this->table . ' (' . implode(', ', $insert_fields) . ') VALUES ' . $values; - } - else - { - $sql .= ', ' . $values; - } - - foreach ($record as $variable => $value) - { - $input_parameters[] = (is_array($value) ? json_encode($value) : $value); - } - - // @todo Check if the column was passed in - if ($this->columns['created_at'] != false) - { - $input_parameters[] = Time::timestamp(); - } - - // @todo Check if the column was passed in - if ($this->columns['created_id'] != false && isset($_SESSION['__pickles']['security']['user_id'])) - { - $input_parameters[] = $_SESSION['__pickles']['security']['user_id']; - } - } - } - - $results = $this->db->execute($sql . ';', $input_parameters); - - // Clears the cache - if ($update && $this->use_cache) - { - $this->cache->delete($cache_keys); - } - - return $results; - } - // Single row INSERT or UPDATE - else - { - // Determines if it's an UPDATE or INSERT - $update = (isset($this->record[$this->columns['id']]) && trim($this->record[$this->columns['id']]) != ''); - - // Starts to build the query, optionally sets PRIORITY, DELAYED and IGNORE syntax - if ($this->replace === true && $this->mysql) - { - $sql = 'REPLACE'; - - if (strtoupper($this->priority) == 'LOW') - { - $sql .= ' LOW_PRIORITY'; - } - elseif ($this->delayed == true) - { - $sql .= ' DELAYED'; - } - - $sql .= ' INTO ' . $this->table; - } - else - { - if ($update == true) - { - $sql = 'UPDATE'; - } - else - { - $sql = 'INSERT'; - - // priority syntax takes priority over delayed - if ($this->mysql) - { - if ($this->priority !== false - && in_array(strtoupper($this->priority), ['LOW', 'HIGH'])) - { - $sql .= ' ' . strtoupper($this->priority) . '_PRIORITY'; - } - elseif ($this->delayed == true) - { - $sql .= ' DELAYED'; - } - - if ($this->ignore == true) - { - $sql .= ' IGNORE'; - } - } - - $sql .= ' INTO'; - } - - $sql .= ' ' . $this->table . ($update ? ' SET ' : ' '); - } - - $input_parameters = null; - - // Limits the columns being updated - $record = ($update ? array_diff_assoc( - $this->record, - isset($this->original[$this->index]) ? $this->original[$this->index] : [] - ) : $this->record); - - // Makes sure there's something to INSERT or UPDATE - if (count($record) > 0) - { - if ($this->replace && $update) - { - $update = false; - } - - $insert_fields = []; - - // Loops through all the columns and assembles the query - foreach ($record as $column => $value) - { - if ($column != $this->columns['id']) - { - if ($update == true) - { - if ($input_parameters != null) - { - $sql .= ', '; - } - - $sql .= $column . ' = '; - - if (in_array($value, ['++', '--'])) - { - $sql .= $column . ' ' . substr($value, 0, 1) . ' ?'; - $value = 1; - } - else - { - $sql .= '?'; - } - } - else - { - $insert_fields[] = $column; - } - - $input_parameters[] = (is_array($value) ? json_encode($value) : $value); - } - } - - // If it's an UPDATE tack on the ID - if ($update == true) - { - if ($this->columns['updated_at'] != false) - { - if ($input_parameters != null) - { - $sql .= ', '; - } - - $sql .= $this->columns['updated_at'] . ' = ?'; - $input_parameters[] = Time::timestamp(); - } - - if ($this->columns['updated_id'] != false && isset($_SESSION['__pickles']['security']['user_id'])) - { - if ($input_parameters != null) - { - $sql .= ', '; - } - - $sql .= $this->columns['updated_id'] . ' = ?'; - - $input_parameters[] = $_SESSION['__pickles']['security']['user_id']; - } - - $sql .= ' WHERE ' . $this->columns['id'] . ' = ?' . ($this->mysql ? ' LIMIT 1' : '') . ';'; - $input_parameters[] = $this->record[$this->columns['id']]; - } - else - { - // @todo REPLACE should be grabbing the previous values so - // that we're not wiping out pertinent data when the - // internal columns are in use. This includes the - // `id` column that is needed to keep it from doing - // an INSERT instead of an UPDATE - if ($this->columns['created_at'] != false || $this->replace) - { - $insert_fields[] = $this->columns['created_at']; - $input_parameters[] = Time::timestamp(); - } - - if ($this->columns['created_id'] != false && isset($_SESSION['__pickles']['security']['user_id'])) - { - $insert_fields[] = $this->columns['created_id']; - $input_parameters[] = $_SESSION['__pickles']['security']['user_id']; - } - - $sql .= '(' . implode(', ', $insert_fields) . ') VALUES (' . implode(', ', array_fill(0, count($input_parameters), '?')) . ')'; - - // PDO::lastInsertID() doesn't work so we return the ID with the query - if ($this->postgresql) - { - $sql .= ' RETURNING ' . $this->columns['id']; - } - - $sql .= ';'; - } - - // Executes the query - if ($this->postgresql && $update == false) - { - return $this->db->fetch($sql, $input_parameters); - } - else - { - $results = $this->db->execute($sql, $input_parameters); - - // Clears the cache - if ($update && $this->use_cache) - { - $this->cache->delete(strtoupper($this->model) . '-' . $this->record[$this->columns['id']]); - } - - return $results; - } - } - } - - return false; - } - - /** - * Delete Record - * - * DELETEs the current record from the database. - * - * @return boolean status of the query - */ - public function delete() - { - if (isset($this->record[$this->columns['id']])) - { - // Logical deletion - if ($this->columns['is_deleted']) - { - $sql = 'UPDATE ' . $this->table . ' SET ' . $this->columns['is_deleted'] . ' = ?'; - $input_parameters = ['1']; - - if ($this->columns['deleted_at']) - { - $sql .= ', ' . $this->columns['deleted_at'] . ' = ?'; - $input_parameters[] = Time::timestamp(); - } - - if ($this->columns['deleted_id'] && isset($_SESSION['__pickles']['security']['user_id'])) - { - $sql .= ', ' . $this->columns['deleted_id'] . ' = ?'; - $input_parameters[] = $_SESSION['__pickles']['security']['user_id']; - } - - $sql .= ' WHERE ' . $this->columns['id'] . ' = ?'; - } - // For reals deletion - else - { - $sql = 'DELETE FROM ' . $this->table . ' WHERE ' . $this->columns['id'] . ' = ?' . ($this->mysql ? ' LIMIT 1' : '') . ';'; - } - - $input_parameters[] = $this->record[$this->columns['id']]; - $results = $this->db->execute($sql, $input_parameters); - - // Clears the cache - if ($this->use_cache) - { - $this->cache->delete(strtoupper($this->model) . '-' . $this->record[$this->columns['id']]); - } - - return $results; - } - else - { - return false; - } - } - - // }}} - // {{{ Utility Methods - - /** - * Prepare Parameters - * - * Checks if the parameters array is only integers and reconstructs the - * array with the proper conditions format. - * - * @param array $array parameters array, passed by reference - */ - public function prepareParameters(&$parameters) - { - $all_integers = true; - - foreach ($parameters as $key => $value) - { - if (!ctype_digit((string)$key) || !ctype_digit((string)$value)) - { - $all_integers = false; - } - } - - if ($all_integers) - { - $parameters = ['conditions' => [$this->columns['id'] => $parameters]]; - } - } - - /** - * Load Parameters - * - * Loads the passed parameters back into the object. - * - * @param array $parameters key / value list - * @param boolean whether or not the parameters were loaded - */ - public function loadParameters($parameters) - { - if (is_array($parameters)) - { - $conditions = true; - - // Adds the parameters to the object - foreach ($parameters as $key => $value) - { - // Clean up the variable just in case - $key = trim(strtolower($key)); - - // Assigns valid keys to the appropriate class property - if (in_array($key, ['fields', 'table', 'conditions', 'group', 'having', 'order', 'limit', 'offset'])) - { - $this->$key = $value; - $conditions = false; - } - } - - // If no valid properties were found, assume it's the conditionals - if ($conditions == true) - { - $this->conditions = $parameters; - } - - return true; - } - - return false; - } - - /** - * Field Values - * - * Pulls the value from a single field and returns an array without any - * duplicates. Perfect for extracting foreign keys to use in later queries. - * - * @param string $field field we want the values for - * @return array values for the passed field - */ - public function fieldvalues($field) - { - $values = []; - - foreach ($this->records as $record) - { - $values[] = $record[$field]; - } - - return array_unique($values); - } - - // }}} -} - diff --git a/src/classes/Module.php b/src/classes/Module.php deleted file mode 100644 index 44c9a26..0000000 --- a/src/classes/Module.php +++ /dev/null @@ -1,293 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Module Class - * - * This is a parent class that all PICKLES modules should be extending. Each - * module can specify it's own meta data and whether or not a user must be - * properly authenticated to view the page. Currently any pages without a - * template are treated as pages being requested via AJAX and the return will - * be JSON encoded. In the future this may need to be changed out for logic - * that allows the requested module to specify what display type(s) it can use. - */ -class Module extends Object -{ - /** - * Page Title - * - * @var string, null by default - * @todo Abandon for $this->meta - */ - public $title = null; - - /** - * Meta Description - * - * @var string, null by default - * @todo Abandon for $this->meta - */ - public $description = null; - - /** - * Meta Keywords (comma separated) - * - * @var string, null by default - * @todo Abandon for $this->meta - */ - public $keywords = null; - - /** - * Meta Data - * - * @var array - */ - public $meta = [ - 'title' => '', - 'description' => '', - 'keywords' => '', - ]; - - /** - * Secure - * - * Whether or not the page should be loaded via SSL. - * - * @var boolean defaults to false - */ - public $secure = false; - - /** - * Security Settings - * - * @var boolean, null by default - */ - public $security = null; - - /** - * AJAX - * - * Whether or not the module is being called via AJAX. This determines if - * errors should be returned as JSON or if it should use the Error class - * which can be interrogated from within a template. - * - * @var boolean, false (not AJAX) by default - * @todo Doesn't seem to be in use, but I have it defined on Clipinary - * don't want to remove until I drop it else it would end up in the - * module return array. - */ - public $ajax = false; - - /** - * Method - * - * Request methods that are allowed to access the module. - * - * @var string or array, null by default - */ - public $method = null; - - /** - * Validate - * - * Variables to validate. - * - * @var array - */ - public $validate = []; - - /** - * Template - * - * This is the parent template that will be loaded if you are using the - * 'template' return type in the Display class. Parent templates are found - * in ./templates/__shared and use the phtml extension. - * - * @var string, 'index' by default - */ - public $template = 'index'; - - /** - * Return - * - * Array that is returned to the template in the case of the module not - * returning anything itself. This is somewhat of a one way trip as you - * cannot get the variable unless you reference the return array explicitly - * $this->return['variable'] - * - * @var array - * @todo Rename __return so it's kinda obscured - * @todo Will need to update leaderbin and sndcrd to use new variable - */ - public $return = []; - - /** - * Output - * - * What should the class render as output? This can be a string or an array - * containing either 'json', 'rss', 'template' or 'xml'. Default is to use - * templates and if the template is not present, fall back to JSON. - * - * @var mixed string or array - */ - public $output = ['template', 'json']; - - /** - * Constructor - * - * The constructor does nothing by default but can be passed a boolean - * variable to tell it to automatically run the __default() method. This is - * typically used when a module is called outside of the scope of the - * controller (the registration page calls the login page in this manner. - * - * @param boolean $autorun optional flag to autorun __default() - * @param boolean $valiate optional flag to disable autorun validation - */ - public function __construct($autorun = false, $validate = true) - { - parent::__construct(['cache', 'db']); - - if ($autorun === true) - { - if ($validate === true) - { - $errors = $this->__validate(); - - if ($errors !== false) - { - // @todo Fatal error perhaps? - exit('Errors encountered, this is a @todo for form validation when calling modules from inside of modules'); - } - } - - $this->__default(); - } - } - - /** - * Default "Magic" Method - * - * This function is overloaded by the module. The __default() method is - * where you want to place any code that needs to be executed at runtime. - */ - public function __default() - { - - } - - /** - * Magic Setter Method - * - * Places undefined properties into the return array as part of the - * module's payload. - * - * @param string $name name of the variable to be set - * @param mixed $value value of the variable to be set - */ - public function __set($name, $value) - { - $this->return[$name] = $value; - } - - /** - * Magic Getter Method - * - * Any variables not defined in this class are set in the return array and - * default to false if not defined there. - * - * @param string $name name of the variable requested - * @return mixed value of the variable or boolean false - */ - public function __get($name) - { - if (!isset($this->return[$name])) - { - return false; - } - else - { - return $this->return[$name]; - } - } - - /** - * Validate - * - * Internal validation for data passed to a Module. Grabs the super global - * based on the Module's request method and loops through the data using the - * Module's validation array (if present) sanity checking each variable - * against the rules. - * - * @return mixed boolean false if everything is fine or an array or errors - */ - public function __validate() - { - $errors = []; - - if ($this->validate) - { - if (is_array($this->method)) - { - $this->method = $this->method[0]; - } - - switch (strtoupper($this->method)) - { - case 'GET': - $global = &$_GET; - break; - - case 'POST': - $global = &$_POST; - break; - - default: - $global = &$_REQUEST; - break; - } - - foreach ($this->validate as $variable => $rules) - { - if (!is_array($rules) && $rules !== true) - { - $variable = $rules; - $rules = true; - } - - if (isset($global[$variable]) && !String::isEmpty($global[$variable])) - { - if (is_array($rules)) - { - $rule_errors = Validate::isValid($global[$variable], $rules); - - if (is_array($rule_errors)) - { - $errors = array_merge($errors, $rule_errors); - } - } - } - else - { - $errors[] = 'The ' . $variable . ' field is required.'; - } - } - } - - return $errors == [] ? false : $errors; - } -} - diff --git a/src/classes/Number.php b/src/classes/Number.php deleted file mode 100644 index 698bd84..0000000 --- a/src/classes/Number.php +++ /dev/null @@ -1,70 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Number Class - * - * Just a simple collection of static functions to accomplish some of the more - * redundant numeric related manipulation. - */ -class Number -{ - /** - * Ordinal Indiciator - * - * Formats a number by appending an ordinal indicator. - * - * @static - * @link http://en.wikipedia.org/wiki/Ordinal_indicator - * @link http://en.wikipedia.org/wiki/English_numerals#Ordinal_numbers - * @param string $number number to format - * @param boolean $superscript include tags - * @return string formatted number - */ - public static function ordinalIndicator($number, $superscript = false) - { - if (!in_array(($number % 100), [11, 12, 13])) - { - switch ($number % 10) - { - case 1: - $suffix = 'st'; - break; - - case 2: - $suffix = 'nd'; - break; - - case 3: - $suffix = 'rd'; - break; - - default: - $suffix = 'th'; - break; - } - } - - if ($superscript) - { - $suffix = '' . $suffix . ''; - } - - return $number . $suffix; - } -} - diff --git a/src/classes/Profiler.php b/src/classes/Profiler.php deleted file mode 100644 index c5a8e88..0000000 --- a/src/classes/Profiler.php +++ /dev/null @@ -1,389 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Profiler Class - * - * The Profiler class is statically interfaced with and allows for in depth - * profiling of a site. By default profiling is off, but can be enabled in the - * config.ini for a site. Out of the box the profiler will report on every - * class object in the system that extends the code Object class. - * - * Note: I really wanted to use PHP Quick Profiler by Ryan Campbell of - * Particletree but it kept barking out errors when I tried to use it with - * E_STRICT turned on. Here's a link anyway since it looks awesome: - * http://particletree.com/features/php-quick-profiler/ - * - * @usage Profiler::log('some action you want to track'); - * @usage Profiler::log($object, 'methodName'); - */ -class Profiler -{ - /** - * Profile - * - * Array of logged events - * - * @static - * @access private - * @var array - */ - private static $profile = []; - - /** - * Queries - * - * Number of queries that have been logged - * - * @static - * @access private - * @var integer - */ - private static $queries = 0; - - /** - * Timers - * - * Array of active timers - * - * @static - * @access private - * @var array - */ - private static $timers = []; - - /** - * Enabled - * - * Checks if the profiler is set to boolean true or if the passed type is - * specified in the profiler configuration value. - * - * @param array $type type(s) to check - * @return boolean whether or not the type is enabled - */ - public static function enabled(/* polymorphic */) - { - $config = Config::getInstance(); - $config = isset($config->pickles['profiler']) ? $config->pickles['profiler'] : false; - - // Checks if we're set to boolean true - if ($config === true) - { - return true; - } - else - { - $types = func_get_args(); - - foreach ($types as $type) - { - if (stripos($config, $type) !== false) - { - return true; - } - } - } - - return false; - } - - /** - * Log - * - * Logs the event to be displayed later on. Due to the nature of how much - * of a pain it is to determine which class method called this method I - * opted to make the method a passable argument for ease of use. Perhaps - * I'll revisit in the future. Handles all elapsed time calculations and - * memory usage. - * - * @static - * @param mixed $data data to log - * @param string $method name of the class method being logged - */ - public static function log($data, $method = false, $type = false) - { - $time = microtime(true); - $data_type = ($data == 'timer' ? $data : gettype($data)); - - // Tidys the data by type - switch ($data_type) - { - case 'array': - $log = '
' . print_r($data, true) . '
'; - break; - - case 'object': - $log = '[' . get_parent_class($data) . '] ' - . '' . get_class($data) . '' - . ($method != '' ? '->' . $method . '()' : ''); - - $data_type = '' . $data_type . ''; - break; - - case 'timer': - $log = $method; - - $data_type = '' . $data_type . ''; - break; - - case 'string': - default: - if ($type != false) - { - $data_type = $type; - } - - $log = $data; - break; - } - - self::$profile[] = [ - 'log' => $log, - 'type' => $data_type, - 'time' => $time, - 'elapsed' => $time - $_SERVER['REQUEST_TIME_FLOAT'], - 'memory' => memory_get_usage(), - ]; - } - - /** - * Log Query - * - * Serves as a wrapper to get query data to the log function - * - * @static - * @param string $query the query being executed - * @param array $input_parameters optional prepared statement data - * @param array $explain EXPLAIN data for the query - * @param float $duration the speed of the query - */ - public static function logQuery($query, $input_parameters = false, $explain = false, $duration = false) - { - self::$queries++; - - $log = ''; - - if ($input_parameters != 'false' && is_array($input_parameters)) - { - $log .= '
'; - - foreach ($input_parameters as $key => $value) - { - $log .= '
' . $key . ' => ' . $value . ''; - - $query = str_replace($key, '' . $key . '', $query); - } - } - - $log = '' . $query . '' . $log; - - if (is_array($explain)) - { - $log .= '
'; - - foreach ($explain as $table) - { - $log .= '
Possible Keys => ' . ($table['possible_keys'] == '' ? 'NONE' : $table['possible_keys']) . '' - . '
Key => ' . ($table['key'] == '' ? 'NONE' : $table['key']) . '' - . '
Type => ' . $table['type'] . '' - . '
Rows => ' . $table['rows'] . '' - . ($table['Extra'] != '' ? '
Extra => ' . $table['Extra'] . '' : ''); - } - } - - $log .= '

Speed: ' . number_format($duration * 100, 3) . ' ms'; - - self::log($log, false, 'database'); - } - - /** - * Timer - * - * Logs the start and end of a timer. - * - * @param string $timer name of the timer - * @return boolean whether or not timer profiling is enabled - */ - public static function timer($timer) - { - if (self::enabled('timers')) - { - // Starts the timer - if (!isset(self::$timers[$timer])) - { - self::$timers[$timer] = microtime(true); - self::Log('timer', 'Started timer ' . $timer . ''); - } - // Ends the timer - else - { - self::Log('timer', 'Stopped timer ' . $timer . ' => Time Elapsed: ' . number_format((microtime(true) - self::$timers[$timer]) * 100, 3) . ' ms'); - - unset(self::$timers[$timer]); - } - - return true; - } - - return false; - } - - /** - * Report - * - * Generates the Profiler report that is displayed by the Controller. - * Contains all the HTML needed to display the data properly inline on the - * page. Will generally be displayed after the closing HTML tag. - * - * @todo Thinking this should return the report and not necessarily echo it - */ - public static function report() - { - ?> - -
- PICKLES Profiler

- There is nothing to profile. This often happens when the profiler configuration is set to either "queries" or "explains" and there are no database queries on the page (common on pages that only have a template). You may want to set the profiler to boolean true to ensure you get a profile of the page.'; - } - else - { - $start_time = $_SERVER['REQUEST_TIME_FLOAT']; - $peak_usage = self::formatSize(memory_get_peak_usage()); - $end_time = self::$profile[count(self::$profile) - 1]['time']; // @todo No idea what though? - $duration = ($end_time - $start_time); - - $logs = count(self::$profile); - $logs .= ' Log' . ($logs == 1 ? '' : 's'); - - $files = count(get_included_files()); - $files .= ' File' . ($files == 1 ? '' : 's'); - - $queries = self::$queries . ' Quer'. (self::$queries == 1 ? 'y' : 'ies'); - ?> - - - - - - - - -
- Console -
-
- Load Time -
-
- Memory Usage -
-
- Database -
-
- Includes -
-
- - - - - - - $entry) - { - ?> - - - - - - - -
ConsoleMemoryTime
ms
- -
-

- - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Security Class - * - * Collection of static methods for handling security within a website running - * on PICKLES. Requires sessions to be enabled. - * - * @usage Security::login(10); - * @usage Security::isLevel(SECURITY_LEVEL_ADMIN); - */ -class Security -{ - /** - * Lookup Cache - * - * Used to minimize database lookups - * - * @static - * @access private - * @var array - */ - private static $cache = []; - - /** - * Generate Hash - * - * Generates an SHA1 hash from the provided string. Salt optional. - * - * @param string $source value to hash - * @param mixed $salts optional salt or salts - * @return string SHA1 hash - * @todo Transition away from this - */ - public static function generateHash($source, $salts = null) - { - // Determines which salt(s) to use - if ($salts == null) - { - $config = Config::getInstance(); - - if (isset($config->security['salt']) && $config->security['salt'] != null) - { - $salts = $config->security['salt']; - } - else - { - $salts = ['P1ck73', 'Ju1C3']; - } - } - - // Forces the variable to be an array - if (!is_array($salts)) - { - $salts = [$salts]; - } - - // Loops through the salts, applies them and calculates the hash - $hash = $source; - - foreach ($salts as $salt) - { - $hash = sha1($salt . $hash); - } - - return $hash; - } - - /** - * Generate SHA-256 Hash - * - * Generates an SHA-256 hash from the provided string and salt. Borrowed the - * large iteration logic from fCryptography::hashWithSalt() as, and I quote, - * "makes rainbow table attacks infesible". - * - * @param string $source value to hash - * @param mixed $salt value to use as salt - * @return string SHA-256 hash - * @link https://github.com/flourishlib/flourish-classes/blob/master/fCryptography.php - */ - public static function generateSHA256Hash($source, $salt) - { - $sha256 = sha1($salt . $source); - - for ($i = 0; $i < 1000; $i++) - { - $sha256 = hash('sha256', $sha256 . (($i % 2 == 0) ? $source : $salt)); - } - - return $sha256; - } - - /** - * Check Session - * - * Checks if sessions are enabled. - * - * @static - * @access private - * @return boolean whether or not sessions are enabled - */ - private static function checkSession() - { - if (session_id() == '') - { - return false; - } - else - { - return true; - } - } - - /** - * Check Level - * - * Checks if a passed level is an integer and/or properly defined in the - * site's configuration file. - * - * @static - * @access private - * @param mixed access level to validate - * @return whether ot not the access level is valid - */ - private static function checkLevel(&$access_level) - { - return is_int($access_level); - } - - /** - * Login - * - * Creates a session variable containing the user ID and generated token. - * The token is also assigned to a cookie to be used when validating the - * security level. When the level value is present, the class will by pass - * the database look up and simply use that value when validating (the less - * paranoid scenario). - * - * @static - * @param integer $user_id ID of the user that's been logged in - * @param integer $level optional level for the user being logged in - * @param string $role textual representation of the user's level - * @return boolean whether or not the login could be completed - */ - public static function login($user_id, $level = null, $role = null) - { - if (self::checkSession()) - { - $token = sha1(microtime()); - - $_SESSION['__pickles']['security'] = [ - 'token' => $token, - 'user_id' => (int)$user_id, - 'level' => $level, - 'role' => $role, - ]; - - setcookie('pickles_security_token', $token); - - return true; - } - else - { - return false; - } - } - - /** - * Logout - * - * Clears out the security information in the session and the cookie. - * - * @static - * @return boolean true - */ - public static function logout() - { - if (isset($_SESSION['__pickles']['security'])) - { - $_SESSION['__pickles']['security'] = null; - unset($_SESSION['__pickles']['security']); - - setcookie('pickles_security_token', '', time() - 3600); - } - - return true; - } - - /** - * Get User Level - * - * Looks up the user level in the database and caches it. Cache is used - * for any subsequent look ups for the user. Also validates the session - * variable against the cookie to ensure everything is legit. If the user - * level is set in the session, that value will take precedence. - * - * return integer user level or false - */ - private static function getUserLevel() - { - if (self::checkSession() == true && isset($_SESSION['__pickles']['security']['user_id'])) - { - // Checks the session against the cookie - if (isset($_SESSION['__pickles']['security']['token'], $_COOKIE['pickles_security_token']) - && $_SESSION['__pickles']['security']['token'] != $_COOKIE['pickles_security_token']) - { - Security::logout(); - } - elseif (isset($_SESSION['__pickles']['security']['level']) && $_SESSION['__pickles']['security']['level'] != null) - { - return $_SESSION['__pickles']['security']['level']; - } - // Used to hit the database to determine the user's level, found it - // to be overkill and just opted for a simple logout. - else - { - Security::logout(); - } - } - - return false; - } - - /** - * Is Level - * - * Checks the user's access level is exactly the passed level - * - * @static - * @param integer $access_level access level to be checked against - * @return boolean whether or not the user is that level - */ - public static function isLevel() - { - $is_level = false; - - if (self::checkSession()) - { - $arguments = func_get_args(); - if (is_array($arguments[0])) - { - $arguments = $arguments[0]; - } - - foreach ($arguments as $access_level) - { - if (self::checkLevel($access_level)) - { - if (self::getUserLevel() == $access_level) - { - $is_level = true; - } - } - } - } - - return $is_level; - } - - /** - * Has Level - * - * Checks the user's access level against the passed level. - * - * @static - * @param integer $access_level access level to be checked against - * @return boolean whether or not the user has access - */ - public static function hasLevel() - { - $has_level = false; - - if (self::checkSession()) - { - $arguments = func_get_args(); - - if (is_array($arguments[0])) - { - $arguments = $arguments[0]; - } - - foreach ($arguments as $access_level) - { - if (self::checkLevel($access_level)) - { - if (self::getUserLevel() >= $access_level) - { - $has_level = true; - } - } - } - } - - return $has_level; - } - - /** - * Between Level - * - * Checks the user's access level against the passed range. - * - * @static - * @param integer $low access level to be checked against - * @param integer $high access level to be checked against - * @return boolean whether or not the user has access - */ - public static function betweenLevel($low, $high) - { - $between_level = false; - - if (self::checkSession()) - { - if (self::checkLevel($low) && self::checkLevel($high)) - { - $user_level = self::getUserLevel(); - - if ($user_level >= $low && $user_level <= $high) - { - $between_level = true; - } - } - } - - return $between_level; - } -} - diff --git a/src/classes/Session.php b/src/classes/Session.php deleted file mode 100644 index 62b6869..0000000 --- a/src/classes/Session.php +++ /dev/null @@ -1,125 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Session Class - * - * Provides session handling via database instead of the file based session - * handling built into PHP. Using this class requires an array to be defined - * in place of the boolean true/false (on/off). If simply an empty array, the - * datasource will default to the value in $config['pickles']['datasource'] and - * if the table will default to "sessions". The format is as follows: - */ -class Session extends Object -{ - /** - * Constructor - * - * All of our set up logic for the session in contained here. This class is - * initially instantiated from pickles.php. Non-file handlers need to be - * configured in the site's config. MySQL support was dropped in favor of - * in memory stores or simply relying on file based sessions. Why? Because - * using MySQL for sessions is very write intensive and having done it in - * the past I don't recommend it. If you run a single server, files are - * good enough if your volume is lower. Memcache[d] is fine if you don't - * mind logging all of your users off your site when you restart the - * service and/or you run out of memory for the process. Redis is the best - * choice as it can be configured to be persistent and lives in memory. - * This is assuming you don't just want to roll your own sessions, which is - * pretty damn easy as well. - */ - public function __construct() - { - if (isset($_SERVER['REQUEST_METHOD'])) - { - parent::__construct(); - - // Sets up our configuration variables - if (isset($this->config->pickles['sessions'])) - { - $session = $this->config->pickles['sessions']; - } - - $datasources = $this->config->datasources; - $handler = 'files'; - $datasource = false; - - if (isset($session, $datasources[$session])) - { - $datasource = $datasources[$session]; - $handler = $datasource['type']; - - if ($handler != 'files') - { - if (isset($datasource['hostname'], $datasource['port'])) - { - $host = ($handler != 'memcached' ? 'tcp://' : '') - . $datasource['hostname'] . ':' . $datasource['port']; - } - else - { - throw new Exception('You must provide both the hostname and port for the datasource.'); - } - } - } - - switch ($handler) - { - case 'memcache': - ini_set('session.save_handler', 'memcache'); - ini_set('session.save_path', $host . '?persistent=1&weight=1&timeout=1&retry_interval=15'); - break; - - case 'memcached': - ini_set('session.save_handler', 'memcached'); - ini_set('session.save_path', $host); - break; - - case 'redis': - $save_path = $host . '?weight=1'; - - // Database ignored by phpredis when this was coded - if (isset($datasource['database'])) - { - $save_path .= '&database=' . $datasource['database']; - } - - if (isset($datasource['prefix'])) - { - $save_path .= '&prefix=' . $datasource['prefix']; - } - - ini_set('session.save_handler', 'redis'); - ini_set('session.save_path', $save_path); - break; - - case 'files': - ini_set('session.save_handler', 'files'); - break; - } - - // Don't start sessions for people without a user agent and bots. - if (isset($_SERVER['HTTP_USER_AGENT']) - && !String::isEmpty($_SERVER['HTTP_USER_AGENT']) - && !preg_match('/(Baidu|Gigabot|Googlebot|libwww-perl|lwp-trivial|msnbot|SiteUptime|Slurp|WordPress|ZIBB|ZyBorg)/i', $_SERVER['HTTP_USER_AGENT'])) - { - session_start(); - } - } - } -} - diff --git a/src/classes/Sort.php b/src/classes/Sort.php deleted file mode 100644 index ff01ec9..0000000 --- a/src/classes/Sort.php +++ /dev/null @@ -1,71 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Sort Class - * - * I got tired of writing separate usort functions to sort by different array - * keys in the array, this class solves that. - */ -class Sort -{ - /** - * Ascending - * - * Variable to utilize ascending sort - * - * @var integer - */ - const ASC = 'ASC'; - - /** - * Descending - * - * Variable to utilize descending sort - * - * @var integer - */ - const DESC = 'DESC'; - - /** - * Sort By - * - * Sorts an array by the specified column, optionally in either direction. - * - * @param string $field field to sort by - * @param array $array array to sort - * @param string $direction optional direction to sort - * @retun boolean true because sorting is done by reference - */ - public static function by($field, &$array, $direction = Sort::ASC) - { - usort($array, create_function('$a, $b', ' - $a = $a["' . $field . '"]; - $b = $b["' . $field . '"]; - - if ($a == $b) - { - return 0; - } - - return ($a ' . ($direction == Sort::DESC ? '>' : '<') .' $b) ? -1 : 1; - ')); - - return true; - } -} - diff --git a/src/classes/Validate.php b/src/classes/Validate.php deleted file mode 100644 index 2f613a3..0000000 --- a/src/classes/Validate.php +++ /dev/null @@ -1,175 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - */ - -/** - * Validate Class - * - * Validation layer that's used by the Modules to validate passed data. Handles - * single sanity checks against a variable so the validation itself can be used - * in other places in the system - */ -class Validate -{ - /** - * Is Valid? - * - * Checks if a variable is valid based on the passed rules. - * - * @param mixed $value the value to be validated - * @param array $rules an array of rules (and messages) to validate with - * @return mixed boolean true if valid, array of errors if invalid - */ - public static function isValid($value, $rules) - { - $errors = []; - - if (is_array($rules)) - { - foreach ($rules as $rule => $message) - { - $rule = explode(':', $rule); - - switch (strtolower($rule[0])) - { - // @todo case 'alpha': - // @todo case 'alphanumeric': - // @todo case 'date': - - // {{{ Checks using filter_var() - - case 'filter': - if (count($rule) < 2) - { - throw new Exception('Invalid validation rule, expected: "validate:boolean|email|float|int|ip|url".'); - } - else - { - switch (strtolower($rule[1])) - { - case 'boolean': - case 'email': - case 'float': - case 'int': - case 'ip': - case 'url': - $filter = constant('FILTER_VALIDATE_' . strtoupper($rule[1])); - break; - - default: - throw new Exception('Invalid filter, expecting boolean, email, float, int, ip or url.'); - break; - } - - if (!filter_var($value, $filter)) - { - $errors[] = $message; - } - } - - break; - - // }}} - // {{{ Checks using strlen() - - case 'length': - if (count($rule) < 3) - { - throw new Exception('Invalid validation rule, expected: "length:<|<=|==|!=|>=|>:integer".'); - } - else - { - if (!filter_var($rule[2], FILTER_VALIDATE_INT)) - { - throw new Exception('Invalid length value, expecting an integer.'); - } - else - { - $length = strlen($value); - - switch ($rule[1]) - { - case '<': - $valid = $length < $rule[2]; - break; - - case '<=': - $valid = $length <= $rule[2]; - break; - - case '==': - $valid = $length == $rule[2]; - break; - - case '!=': - $valid = $length != $rule[2]; - break; - - case '>=': - $valid = $length >= $rule[2]; - break; - - case '>': - $valid = $length > $rule[2]; - break; - - default: - throw new Exception('Invalid operator, expecting <, <=, ==, !=, >= or >.'); - break; - } - - if (!$valid) - { - $errors[] = $message; - } - } - } - - break; - - // }}} - - // @todo case 'range': - - // {{{ Checks using preg_match() - - case 'regex': - if (count($rule) < 3) - { - throw new Exception('Invalid validation rule, expected: "regex:is|not:string".'); - } - else - { - $rule[1] = strtolower($rule[1]); - - if (($rule[1] == 'is' && preg_match($rule[2], $value)) - || ($rule[1] == 'not' && !preg_match($rule[2], $value))) - { - $errors[] = $message; - } - } - break; - - // }}} - } - - } - } - - return count($errors) ? $errors : true; - } -} - diff --git a/src/pickles.php b/src/pickles.php deleted file mode 100644 index accdec6..0000000 --- a/src/pickles.php +++ /dev/null @@ -1,162 +0,0 @@ - - * @copyright Copyright 2007-2014, Josh Sherman - * @license http://www.opensource.org/licenses/mit-license.html - * @package PICKLES - * @link https://github.com/joshtronic/pickles - * @usage require_once 'pickles.php'; - */ - -// {{{ PICKLES Constants - -// @todo Finish reworking constants to be part of the Config object -if (!defined('SITE_PATH')) -{ - // Establishes our site paths, sanity check is to allow vfsStream in our tests - define('SITE_PATH', getcwd() . '/../'); -} - -if (!defined('SITE_CLASS_PATH')) -{ - define('SITE_CLASS_PATH', SITE_PATH . 'classes/'); - define('SITE_MODEL_PATH', SITE_PATH . 'models/'); - // @todo The following 2 constants are being used in sites will need to update them before removing - define('SITE_MODULE_PATH', SITE_PATH . 'modules/'); - define('SITE_TEMPLATE_PATH', SITE_PATH . 'templates/'); - - define('PRIVATE_PATH', SITE_PATH . 'private/'); - define('LOG_PATH', PRIVATE_PATH . 'logs/'); -} - -// }}} -// {{{ Defaults some important configuration options - -// Turns on error before the config is loaded to help catch parse errors -ini_set('display_errors', true); -error_reporting(-1); - -// Defaults timezone to UTC if not set -if (ini_get('date.timezone') == '') -{ - ini_set('date.timezone', 'Etc/UTC'); -} - -// Sets the session variables -ini_set('session.cache_expire', 86400); -ini_set('session.entropy_file', '/dev/urandom'); -ini_set('session.entropy_length', 512); -ini_set('session.gc_maxlifetime', 86400); -ini_set('session.gc_probability', 1); -ini_set('session.gc_divisor', 1000); -ini_set('session.hash_function', 1); - -// }}} -// {{{ Auto[magical] Loader - -/** - * Magic function to automatically load classes - * - * Attempts to load a core PICKLES class or a site level data model or - * module class. - * - * @param string $class Name of the class to be loaded - * @return boolean Return value of require_once() or false (default) - */ -function __autoload($class) -{ - $loaded = false; - $filename = preg_replace('/_/', '/', $class) . '.php'; - - $pickles_path = dirname(__FILE__) . '/'; - $pickles_paths = [ - 'class' => $pickles_path . 'classes/', - ]; - - // Path as the key, boolean value is whether ot not to convert back to hyphenated - $paths = [ - $pickles_paths['class'] => false, - SITE_CLASS_PATH => false, - SITE_MODEL_PATH => false, - SITE_MODULE_PATH => true, - ]; - - foreach ($paths as $path => $hyphenated) - { - // Converts the filename back to hypenated - if ($hyphenated == true) - { - $filename = strtolower(preg_replace('/([A-Z]{1})/', '-$1', $filename));; - } - - if (file_exists($path . $filename)) - { - $loaded = require_once $path . $filename; - break; - } - } - - return $loaded; -} - -spl_autoload_register('__autoload'); - -// }}} -// {{{ Loads the configuration file and sets any configuration options - -// Loads the base config -$config = Config::getInstance(); - -// Injects PICKLES variables into the config -$config->data['pickles']['path'] = dirname(__FILE__) . '/'; - -// Configures any available PHP configuration options -if (is_array($config->php) && count($config->php)) -{ - foreach ($config->php as $variable => $value) - { - ini_set($variable, $value); - } -} - -// Starts session handling (old) -if (isset($config->pickles['session'])) -{ - if (session_id() == '' && $config->pickles['session'] !== false) - { - new Session(); - } -} - -// Starts session handling (new) -if (isset($config->pickles['sessions'])) -{ - if (session_id() == '' && $config->pickles['sessions'] !== false) - { - new Session(); - } -} - -// }}} -// {{{ Defaults some internals for ease of use - -if (!isset($_REQUEST['request'])) -{ - $_REQUEST['request'] = 'home'; -} - -// }}} - diff --git a/tests/Pickles/ConfigTest.php b/tests/Pickles/ConfigTest.php new file mode 100644 index 0000000..d7b6607 --- /dev/null +++ b/tests/Pickles/ConfigTest.php @@ -0,0 +1,174 @@ +) + */ + public function testMissingCLIEnvironment() + { + $_SERVER['argc'] = 1; + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + ]; + '); + + new Pickles\Config('/tmp/pickles.php'); + } + + /** + * @expectedException Exception + * @expectedExceptionMessage You must pass an environment (e.g. php script.php ) + */ + public function testCLIEnvironmentMissingParameter() + { + $_SERVER['argc'] = 1; + + new Pickles\Config('/tmp/pickles.php'); + } + + public function testEnvironmentMatchCLI() + { + $_SERVER['argc'] = 2; + $_SERVER['argv'][1] = 'local'; + + $config = new Pickles\Config('/tmp/pickles.php'); + + $this->assertEquals('local', $config['environment']); + } + + public function testEnvironmentMatchExact() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + + $config = new Pickles\Config('/tmp/pickles.php'); + + $this->assertEquals('local', $config['environment']); + } + + public function testEnvironmentMatchFuzzy() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['SERVER_NAME'] = '127.0.0.1'; + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "/127\.0\.0\.[0-9]+/", + "production" => "123.456.789.0", + ], + ]; + '); + + $config = new Pickles\Config('/tmp/pickles.php'); + + $this->assertEquals('local', $config['environment']); + } + + /** + * @expectedException Exception + * @expectedExceptionMessage Unable to determine the environment. + */ + public function testEnvironmentNoMatch() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['SERVER_NAME'] = 'lolnope'; + + new Pickles\Config('/tmp/pickles.php'); + } + + public function testProductionDisplayErrors() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['HTTP_HOST'] = '123.456.789.0'; + + ini_set('display_errors', true); + + $this->assertEquals('1', ini_get('display_errors')); + + new Pickles\Config('/tmp/pickles.php'); + + $this->assertEquals('', ini_get('display_errors')); + } + + public function testFlatten() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['HTTP_HOST'] = '123.456.789.0'; + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "/127\.0\.0\.[0-9]+/", + "production" => "123.456.789.0", + ], + "foo" => [ + "local" => "barLocal", + "production" => "barProduction", + ], + "nestedOne" => [ + "nestedTwo" => [ + "local" => "nestedLocal", + "production" => "nestedProduction", + ], + ], + ]; + '); + + $config = new Pickles\Config('/tmp/pickles.php'); + + $this->assertEquals('barProduction', $config['foo']); + $this->assertEquals('nestedProduction', $config['nestedOne']['nestedTwo']); + } + + public function testGetInstance() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['HTTP_HOST'] = '123.456.789.0'; + + $config = Pickles\Config::getInstance('/tmp/pickles.php'); + + $this->assertInstanceOf('Pickles\\Config', $config); + } +} + diff --git a/tests/Pickles/ObjectTest.php b/tests/Pickles/ObjectTest.php new file mode 100644 index 0000000..1961dd8 --- /dev/null +++ b/tests/Pickles/ObjectTest.php @@ -0,0 +1,82 @@ + [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "pickles" => [ + "datasource" => "mysql", + ], + "datasources" => [ + "mysql" => [ + "driver" => "pdo_mysql", + ], + ], + ]; + '); + + $config = Pickles\Config::getInstance('/tmp/pickles.php'); + } + + public static function tearDownAfterClass() + { + unlink('/tmp/pickles.php'); + } + + public function testConstructorWithoutObjects() + { + $object = new Pickles\Object(); + + $this->assertInstanceOf('Pickles\\Config', PHPUnit_Framework_Assert::readAttribute($object, 'config')); + } + + public function testConstructorWithObjects() + { + $object = new Pickles\Object('cache'); + $this->assertInstanceOf('Pickles\\Cache', $object->cache); + + $object = new Pickles\Object(['cache', 'db']); + $this->assertInstanceOf('Pickles\\Cache', $object->cache); + $this->assertInstanceOf('Pickles\\Database', $object->db); + } + + public function testGetInstanceWithoutClass() + { + $this->assertFalse(Pickles\Object::getInstance()); + } + + public function testProfiler() + { + file_put_contents('/tmp/pickles.php', ' [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "pickles" => [ + "datasource" => "mysql", + "profiler" => true, + "foo" => "bar", + ], + "datasources" => [ + "mysql" => [ + "driver" => "pdo_mysql", + ], + ], + ]; + '); + + $config = Pickles\Config::getInstance('/tmp/pickles.php'); + $object = new Pickles\Object(); + } +} + diff --git a/tests/Pickles/ProfilerTest.php b/tests/Pickles/ProfilerTest.php new file mode 100644 index 0000000..8df03d4 --- /dev/null +++ b/tests/Pickles/ProfilerTest.php @@ -0,0 +1,66 @@ + [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "pickles" => [ + "profiler" => true, + ], + ]; + '); + + new Pickles\Config('/tmp/pickles.php'); + + Pickles\Profiler::log('i am a string'); + Pickles\Profiler::log(['foo' => 'bar']); + Pickles\Profiler::log($this, 'testProfiler'); + Pickles\Profiler::timer('swatch'); + Pickles\Profiler::query('SELECT', ['foo' => 'bar'], ['results'], 1, 'EXPLAIN'); + Pickles\Profiler::timer('swatch'); + Pickles\Profiler::query('SELECT', ['foo' => 'bar'], ['results'], 1); + + $report = Pickles\Profiler::report(); + + $this->assertEquals(7, count($report)); + $this->assertEquals(7, count($report['logs'])); + $this->assertEquals(5, count($report['logs'][0])); + $this->assertEquals('string', $report['logs'][0]['type']); + $this->assertEquals('i am a string', $report['logs'][0]['details']); + $this->assertEquals('array', $report['logs'][1]['type']); + $this->assertEquals(['foo' => 'bar'], $report['logs'][1]['details']); + $this->assertEquals('object', $report['logs'][2]['type']); + $this->assertEquals(['class' => 'ProfilerTest', 'method' => 'testProfiler()'], $report['logs'][2]['details']); + $this->assertEquals('timer', $report['logs'][3]['type']); + $this->assertEquals('swatch', $report['logs'][3]['details']['name']); + $this->assertEquals('start', $report['logs'][3]['details']['action']); + $this->assertEquals('database', $report['logs'][4]['type']); + $this->assertEquals('SELECT', $report['logs'][4]['details']['query']); + $this->assertEquals(['foo' => 'bar'], $report['logs'][4]['details']['parameters']); + $this->assertEquals(['results'], $report['logs'][4]['details']['results']); + $this->assertEquals(1, $report['logs'][4]['details']['execution_time']); + $this->assertEquals('EXPLAIN', $report['logs'][4]['details']['explain']); + $this->assertEquals('timer', $report['logs'][5]['type']); + $this->assertEquals('swatch', $report['logs'][5]['details']['name']); + $this->assertEquals('stop', $report['logs'][5]['details']['action']); + $this->assertEquals('database', $report['logs'][6]['type']); + $this->assertEquals('SELECT', $report['logs'][6]['details']['query']); + $this->assertEquals(['foo' => 'bar'], $report['logs'][6]['details']['parameters']); + $this->assertEquals(['results'], $report['logs'][6]['details']['results']); + $this->assertEquals(1, $report['logs'][6]['details']['execution_time']); + $this->assertFalse(isset($report['logs'][6]['details']['explain'])); + } +} + diff --git a/tests/Pickles/ResourceTest.php b/tests/Pickles/ResourceTest.php new file mode 100644 index 0000000..a80c4a3 --- /dev/null +++ b/tests/Pickles/ResourceTest.php @@ -0,0 +1,282 @@ + true, + ]; + + public $auth = [ + 'DELETE' => true, + ]; + + public $filter = [ + 'GET' => [ + 'foo' => 'trim', + 'bar' => 'password_hash', + ], + ]; + + public $validate = [ + 'GET' => [ + 'missing', + 'isBoolean' => ['filter:boolean' => 'Error'], + 'isNotBoolean' => ['filter:boolean' => 'Error'], + 'isEmail' => ['filter:email' => 'Error'], + 'isNotEmail' => ['filter:email' => 'Error'], + 'isFloat' => ['filter:float' => 'Error'], + 'isNotFloat' => ['filter:float' => 'Error'], + 'isInt' => ['filter:int' => 'Error'], + 'isNotInt' => ['filter:int' => 'Error'], + 'isIP' => ['filter:ip' => 'Error'], + 'isNotIP' => ['filter:ip' => 'Error'], + 'isURL' => ['filter:url' => 'Error'], + 'isNotURL' => ['filter:url' => 'Error'], + 'invalidRule' => ['filter' => 'Error'], + 'lessThan' => ['length:<:10' => 'Error'], + 'lessThanEqual' => ['length:<=:10' => 'Error'], + 'equal' => ['length:==:10' => 'Error'], + 'notEqual' => ['length:!=:10' => 'Error'], + 'greaterThan' => ['length:>=:10' => 'Error'], + 'greaterThanEqual' => ['length:>:10' => 'Error'], + 'greaterLessThan' => ['length:><:10' => 'Error'], + 'regex' => ['regex:/[a-z]+/' => 'Error'], + ], + ]; + + public function GET() + { + + } + + public function PUT() + { + return ['foo' => 'bar']; + } + + public function ERROR() + { + throw new \Exception('Error'); + } + } +} + +namespace +{ + class ResourceTest extends PHPUnit_Framework_TestCase + { + public function setUp() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['SERVER_NAME'] = '127.0.0.1'; + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "pickles" => [ + "namespace" => "", + "datasource" => "mysql", + ], + "datasources" => [ + "mysql" => [ + "driver" => "pdo_mysql", + ], + ], + ]; + '); + + Pickles\Config::getInstance('/tmp/pickles.php'); + } + + public function testFilterAndValidate() + { + $response = json_encode([ + 'meta' => [ + 'status' => 400, + 'message' => 'Missing or invalid parameters.', + 'errors' => [ + 'missing' => ['The missing parameter is required.'], + 'isNotBoolean' => ['Error'], + 'isNotEmail' => ['Error'], + 'isNotFloat' => ['Error'], + 'isNotInt' => ['Error'], + 'isNotIP' => ['Error'], + 'isNotURL' => ['Error'], + 'invalidRule' => ['Invalid filter, expecting boolean, email, float, int, ip or url.'], + 'greaterLessThan' => ['Invalid operator, expecting <, <=, ==, !=, >= or >.'], + 'regex' => ['Error'], + ], + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_REQUEST['request'] = 'v1/resource/1'; + $_GET = [ + 'foo' => ' bar ', + 'bar' => 'unencrypted', + 'isBoolean' => true, + 'isNotBoolean' => 'invalid', + 'isEmail' => 'foo@bar.com', + 'isNotEmail' => 'nope', + 'isFloat' => 1.234567890, + 'isNotFloat' => 'five', + 'isInt' => 22381, + 'isNotInt' => 'pretzel', + 'isIP' => '127.0.0.1', + 'isNotIP' => 'home', + 'isURL' => 'http://joshtronic.com', + 'isNotURL' => 'doubleUdoubleUdoubleUdot', + 'invalidRule' => 'invalid', + 'lessThan' => '...', + 'lessThanEqual' => '.......', + 'equal' => '..........', + 'notEqual' => '.......', + 'greaterThan' => '............', + 'greaterThanEqual' => '............', + 'greaterLessThan' => '......', + 'regex' => 'abc', + ]; + + if (version_compare(PHP_VERSION, '5.5.0', '<')) + { + unset($_GET['bar']); + } + + new Pickles\Router(); + + $this->assertEquals('bar', $_GET['foo']); + + if (version_compare(PHP_VERSION, '5.5.0', '>=')) + { + $this->assertFalse('unencrypted' == $_GET['bar']); + } + } + + public function testHTTPS() + { + $response = json_encode([ + 'meta' => [ + 'status' => 400, + 'message' => 'HTTPS is required.', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'POST'; + $_REQUEST['request'] = 'v1/resource/1'; + + new Pickles\Router(); + } + + public function testPUT() + { + $response = json_encode([ + 'meta' => [ + 'status' => 200, + 'message' => 'OK', + ], + 'response' => [ + 'foo' => 'bar', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'PUT'; + $_REQUEST['request'] = 'v1/resource/1'; + + new Pickles\Router(); + } + + public function testMisconfiguredAuth() + { + $response = json_encode([ + 'meta' => [ + 'status' => 401, + 'message' => 'Authentication is not configured properly.', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'DELETE'; + $_REQUEST['request'] = 'v1/resource/1'; + + new Pickles\Router(); + } + + public function testMethodNotAllowed() + { + $response = json_encode([ + 'meta' => [ + 'status' => 405, + 'message' => 'Method not allowed.', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'NOPE'; + $_REQUEST['request'] = 'v1/resource/1'; + + new Pickles\Router(); + } + + public function testLowErrorCode() + { + $response = json_encode([ + 'meta' => [ + 'status' => 500, + 'message' => 'Error', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'ERROR'; + $_REQUEST['request'] = 'v1/resource/1'; + + new Pickles\Router(); + } + + public function testProfiler() + { + $this->expectOutputRegex('/"profiler":{/'); + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "pickles" => [ + "namespace" => "", + "datasource" => "mysql", + "profiler" => true, + ], + "datasources" => [ + "mysql" => [ + "driver" => "pdo_mysql", + ], + ], + ]; + '); + + Pickles\Config::getInstance('/tmp/pickles.php'); + + $_SERVER['REQUEST_METHOD'] = 'PUT'; + $_REQUEST['request'] = 'v1/resource/1'; + + new Pickles\Router(); + } + } +} + diff --git a/tests/Pickles/RouterTest.php b/tests/Pickles/RouterTest.php new file mode 100644 index 0000000..b7993d1 --- /dev/null +++ b/tests/Pickles/RouterTest.php @@ -0,0 +1,101 @@ + [ + 'status' => 500, + 'message' => 'Undefined index: request', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['SERVER_NAME'] = '127.0.0.1'; + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "pickles" => [ + "namespace" => "", + ], + "datasources" => [], + ]; + '); + + Pickles\Config::getInstance('/tmp/pickles.php'); + + new Pickles\Router(); + } + + public function testNotFound() + { + $response = json_encode([ + 'meta' => [ + 'status' => 404, + 'message' => 'Not Found.', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_REQUEST['request'] = 'v1/doesnotexist'; + + new Pickles\Router(); + } + + // We're just testing that the class can be loaded, not that it will + // work. That logic is off in ResourceTest + public function testFoundWithUID() + { + Pickles\Object::$instances = []; + + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_SERVER['SERVER_NAME'] = '127.0.0.1'; + + file_put_contents('/tmp/pickles.php', ' [ + "local" => "127.0.0.1", + "production" => "123.456.789.0", + ], + "datasources" => [], + ]; + '); + + Pickles\Config::getInstance('/tmp/pickles.php'); + + $response = json_encode([ + 'meta' => [ + 'status' => 405, + 'message' => 'Method not allowed.', + ], + ]); + + $this->expectOutputString($response); + + $_SERVER['REQUEST_METHOD'] = 'GET'; + $_REQUEST['request'] = 'v1/router/1'; + + new Pickles\Router(); + } + } +} + diff --git a/tests/classes/StringTest.php b/tests/Pickles/StringTest.php similarity index 53% rename from tests/classes/StringTest.php rename to tests/Pickles/StringTest.php index b91112d..b1d56f0 100644 --- a/tests/classes/StringTest.php +++ b/tests/Pickles/StringTest.php @@ -7,7 +7,7 @@ class StringTest extends PHPUnit_Framework_TestCase */ public function testFormatPhoneNumber($a, $b) { - $this->assertEquals(String::formatPhoneNumber($a), $b); + $this->assertEquals(Pickles\String::formatPhoneNumber($a), $b); } public function providerFormatPhoneNumber() @@ -27,35 +27,35 @@ class StringTest extends PHPUnit_Framework_TestCase public function testIsEmpty() { - $this->assertTrue(String::isEmpty('')); - $this->assertTrue(String::isEmpty(' ')); - $this->assertTrue(String::isEmpty(false)); - $this->assertTrue(String::isEmpty(null)); - $this->assertTrue(String::isEmpty(true, false)); + $this->assertTrue(Pickles\String::isEmpty('')); + $this->assertTrue(Pickles\String::isEmpty(' ')); + $this->assertTrue(Pickles\String::isEmpty(false)); + $this->assertTrue(Pickles\String::isEmpty(null)); + $this->assertTrue(Pickles\String::isEmpty(true, false)); - $this->assertFalse(String::isEmpty(0)); - $this->assertFalse(String::isEmpty('foo')); - $this->assertFalse(String::isEmpty(' bar ')); - $this->assertFalse(String::isEmpty(true)); + $this->assertFalse(Pickles\String::isEmpty(0)); + $this->assertFalse(Pickles\String::isEmpty('foo')); + $this->assertFalse(Pickles\String::isEmpty(' bar ')); + $this->assertFalse(Pickles\String::isEmpty(true)); } public function testRandom() { - $this->assertEquals(strlen(String::random()), 8); - $this->assertEquals(strlen(String::random(16)), 16); + $this->assertEquals(strlen(Pickles\String::random()), 8); + $this->assertEquals(strlen(Pickles\String::random(16)), 16); - $this->assertEquals(preg_match('/[a-z0-9]/', String::random(32, true, true)), 1); - $this->assertEquals(preg_match('/[a-z]/', String::random(32, true, false)), 1); - $this->assertEquals(preg_match('/[0-9]/', String::random(32, false, true)), 1); + $this->assertEquals(preg_match('/[a-z0-9]/', Pickles\String::random(32, true, true)), 1); + $this->assertEquals(preg_match('/[a-z]/', Pickles\String::random(32, true, false)), 1); + $this->assertEquals(preg_match('/[0-9]/', Pickles\String::random(32, false, true)), 1); - $this->assertEquals(preg_match('/[0-9]/', String::random(32, true, false)), 0); - $this->assertEquals(preg_match('/[a-z]/', String::random(32, false, true)), 0); - $this->assertEquals(preg_match('/[a-z0-9]/', String::random(32, false, false)), 0); + $this->assertEquals(preg_match('/[0-9]/', Pickles\String::random(32, true, false)), 0); + $this->assertEquals(preg_match('/[a-z]/', Pickles\String::random(32, false, true)), 0); + $this->assertEquals(preg_match('/[a-z0-9]/', Pickles\String::random(32, false, false)), 0); } public function testRandomSimilarFalse() { - $this->assertRegExp('/[a-hj-np-z2-9]{8}/', String::random(8, true, true, false)); + $this->assertRegExp('/[a-hj-np-z2-9]{8}/', Pickles\String::random(8, true, true, false)); } /** @@ -63,7 +63,7 @@ class StringTest extends PHPUnit_Framework_TestCase */ public function testTruncate($a, $b, $c, $d) { - $this->assertEquals(String::truncate($a, $b, $c), $d); + $this->assertEquals(Pickles\String::truncate($a, $b, $c), $d); } public function providerTruncate() @@ -81,7 +81,7 @@ class StringTest extends PHPUnit_Framework_TestCase */ public function testUpperWords($a, $b) { - $this->assertEquals(String::upperWords($a), $b); + $this->assertEquals(Pickles\String::upperWords($a), $b); } public function providerUpperWords() @@ -100,7 +100,7 @@ class StringTest extends PHPUnit_Framework_TestCase */ public function testGenerateSlug($a, $b) { - $this->assertEquals($b, String::generateSlug($a)); + $this->assertEquals($b, Pickles\String::generateSlug($a)); } public function providerGenerateSlug() @@ -116,10 +116,10 @@ class StringTest extends PHPUnit_Framework_TestCase public function testPluralize() { - $this->assertEquals('test', String::pluralize('test', 1, false)); - $this->assertEquals('1 test', String::pluralize('test', 1, true)); - $this->assertEquals('tests', String::pluralize('test', 2, false)); - $this->assertEquals('2 tests', String::pluralize('test', 2, true)); + $this->assertEquals('test', Pickles\String::pluralize('test', 1, false)); + $this->assertEquals('1 test', Pickles\String::pluralize('test', 1, true)); + $this->assertEquals('tests', Pickles\String::pluralize('test', 2, false)); + $this->assertEquals('2 tests', Pickles\String::pluralize('test', 2, true)); } } diff --git a/tests/Pickles/TimeTest.php b/tests/Pickles/TimeTest.php new file mode 100644 index 0000000..414f906 --- /dev/null +++ b/tests/Pickles/TimeTest.php @@ -0,0 +1,182 @@ +assertEquals(Pickles\Time::age($a), $b); + } + + public function providerAge() + { + $time = strtotime('-25 years'); + + return [ + [date('Y-m-d', $time), '25'], + [date('m/d/Y', $time), '25'], + [date('r', $time), '25'], + ['today', '0'], + ['400 days ago', '1'], + [true, Pickles\Time::age('1969-12-31')], + ]; + } + + public function testAgePastTime() + { + $this->assertEquals(18, Pickles\Time::age(date('Y-m-d', strtotime('-18 years')))); + } + + public function testAgeFutureTime() + { + $this->assertEquals(-18, Pickles\Time::age(date('Y-m-d', strtotime('18 years')))); + } + + public function testAgeWrongFormat() + { + $this->assertEquals(17, Pickles\Time::age(date('Ymd', strtotime('December 31st -18 years')))); + } + + public function testAgoJustNow() + { + $this->assertEquals('just now', Pickles\Time::ago(Pickles\Time::timestamp())); + } + + public function testAgoPastTimeSeconds() + { + $this->assertEquals('seconds ago', Pickles\Time::ago(strtotime('-30 seconds'))); + } + + public function testAgoPastTimeMinute() + { + $this->assertEquals('a minute ago', Pickles\Time::ago(strtotime('-1 minutes'))); + } + + public function testAgoPastTimeMinutes() + { + $this->assertEquals('5 minutes ago', Pickles\Time::ago(strtotime('-5 minutes'))); + } + + public function testAgoPastTimeHour() + { + $this->assertEquals('an hour ago', Pickles\Time::ago(strtotime('-1 hours'))); + } + + public function testAgoPastTimeHours() + { + $this->assertEquals('2 hours ago', Pickles\Time::ago(strtotime('-2 hours'))); + } + + public function testAgoPastTimeDay() + { + $this->assertEquals('a day ago', Pickles\Time::ago(strtotime('-1 days'))); + } + + public function testAgoPastTimeDays() + { + $this->assertEquals('2 days ago', Pickles\Time::ago(strtotime('-2 days'))); + } + + public function testAgoPastTimeWeek() + { + $this->assertEquals('a week ago', Pickles\Time::ago(strtotime('-1 weeks'))); + } + + public function testAgoPastTimeWeeks() + { + $this->assertEquals('2 weeks ago', Pickles\Time::ago(strtotime('-2 weeks'))); + } + + public function testAgoPastTimeMonth() + { + $this->assertEquals('a month ago', Pickles\Time::ago(strtotime('-1 months'))); + } + + public function testAgoPastTimeMonths() + { + $this->assertEquals('2 months ago', Pickles\Time::ago(strtotime('-2 months'))); + } + + public function testAgoPastTimeYear() + { + $this->assertEquals('a year ago', Pickles\Time::ago(strtotime('-1 years'))); + } + + public function testAgoPastTimeYears() + { + $this->assertEquals('2 years ago', Pickles\Time::ago(strtotime('-2 years'))); + } + + public function testAgoFutureTimeSeconds() + { + $this->assertEquals('seconds from now', Pickles\Time::ago(strtotime('+30 seconds'))); + } + + public function testAgoFutureTimeMinutes() + { + $this->assertEquals('5 minutes from now', Pickles\Time::ago(strtotime('+5 minutes'))); + } + + public function testAgoFutureTimeHours() + { + $this->assertEquals('an hour from now', Pickles\Time::ago(strtotime('+1 hour'))); + } + + public function testAgoFutureTimeDays() + { + $this->assertEquals('a day from now', Pickles\Time::ago(strtotime('+1 day'))); + } + + public function testAgoFutureTimeWeeks() + { + $this->assertEquals('a week from now', Pickles\Time::ago(strtotime('+1 week'))); + } + + public function testAgoFutureTimeMonths() + { + $this->assertEquals('a month from now', Pickles\Time::ago(strtotime('+1 month'))); + } + + public function testAgoFutureTimeYears() + { + $this->assertEquals('a year from now', Pickles\Time::ago(strtotime('+1 year'))); + } + + public function testTimestamp() + { + $this->assertEquals(gmdate('Y-m-d H:i:s'), Pickles\Time::timestamp()); + } + + public function testRoundUpHour() + { + $this->assertEquals('an hour ago', Pickles\Time::ago(strtotime('-59 minutes -55 seconds'))); + } + + public function testRoundUpDay() + { + $this->assertEquals('a day ago', Pickles\Time::ago(strtotime('-23 hours -55 minutes'))); + } + + public function testRoundUpWeek() + { + $this->assertEquals('a week ago', Pickles\Time::ago(strtotime('-6 days -23 hours'))); + } + + public function testRoundUpMonth() + { + $this->assertEquals('a month ago', Pickles\Time::ago(strtotime('-29 days'))); + } + + public function testRoundUpYear() + { + $this->assertEquals('a year ago', Pickles\Time::ago(strtotime('-364 days'))); + } +} + diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 4f614a2..032298c 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -1,38 +1,7 @@ ' - ); -} - `mysql -e 'TRUNCATE TABLE test.pickles;'`; `mysql -e 'TRUNCATE TABLE test.mypickles;'`; `mysql -e 'TRUNCATE TABLE test.users;'`; diff --git a/tests/classes/BrowserTest.php b/tests/classes/BrowserTest.php deleted file mode 100644 index f6df803..0000000 --- a/tests/classes/BrowserTest.php +++ /dev/null @@ -1,105 +0,0 @@ -assertInstanceOf('Browser', Browser::getInstance()); - } - - public function testSetAndGet() - { - $this->assertTrue(Browser::set('foo', 'bar')); - $this->assertEquals('bar', Browser::get('foo')); - } - - public function testMissingVariable() - { - $this->assertFalse(Browser::get('missing')); - } - - public function testGoHome() - { - Browser::goHome(); - $this->assertTrue(in_array('Location: http://testsite.com/', xdebug_get_headers())); - } - - public function testIsMobile() - { - $_SERVER['HTTP_USER_AGENT'] = 'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_0 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7A341 Safari/528.16'; - - $this->assertTrue(Browser::isMobile()); - } - - public function testIsNotMobile() - { - $_SERVER['HTTP_USER_AGENT'] = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_1) AppleWebKit/537.73.11 (KHTML, like Gecko) Version/7.0.1 Safari/537.73.11'; - - $this->assertFalse(Browser::isMobile()); - } - - public function testRemoteIPNone() - { - $this->assertFalse(Browser::remoteIP()); - } - - public function testRemoteIPRemoteAddress() - { - $_SERVER['REMOTE_ADDR'] = '1.2.3.4'; - - $this->assertEquals('1.2.3.4', Browser::remoteIP()); - } - - public function testRemoteIPHTTPXForwardedFor() - { - $_SERVER['HTTP_X_FORWARDED_FOR'] = '2.3.4.5'; - - $this->assertEquals('2.3.4.5', Browser::remoteIP()); - } - - public function testRemoteIPHTTPClientIP() - { - $_SERVER['HTTP_CLIENT_IP'] = '3.4.5.6'; - - $this->assertEquals('3.4.5.6', Browser::remoteIP()); - } - - public function testStatus1xx() - { - Browser::status(100); - $this->assertTrue(in_array('Status: 100 Continue', xdebug_get_headers())); - } - - public function testStatus2xx() - { - Browser::status(200); - $this->assertTrue(in_array('Status: 200 OK', xdebug_get_headers())); - } - - public function testStatus3xx() - { - Browser::status(300); - $this->assertTrue(in_array('Status: 300 Multiple Choices', xdebug_get_headers())); - } - - public function testStatus4xx() - { - Browser::status(400); - $this->assertTrue(in_array('Status: 400 Bad Request', xdebug_get_headers())); - } - - public function testStatus5xx() - { - Browser::status(500); - $this->assertTrue(in_array('Status: 500 Internal Server Error', xdebug_get_headers())); - } - - public function testRefresh() - { - $_SERVER['REQUEST_URI'] = '/some/uri'; - Browser::goHome(); - Browser::refresh(); - $this->assertTrue(in_array('Location: http://testsite.com/some/uri', xdebug_get_headers())); - } -} - diff --git a/tests/classes/CacheTest.php b/tests/classes/CacheTest.php deleted file mode 100644 index 13ecbc1..0000000 --- a/tests/classes/CacheTest.php +++ /dev/null @@ -1,87 +0,0 @@ -config = Config::getInstance(); - $this->config->data['pickles']['cache'] = 'mc'; - $this->config->data['datasources']['mc'] = [ - 'type' => 'memcache', - 'hostname' => 'localhost', - 'port' => 11211, - 'namespace' => 'ns', - ]; - - $this->cache = Cache::getInstance(); - } - - public function testGetInstance() - { - $this->assertInstanceOf('Cache', $this->cache); - } - - public function testSetAndGet() - { - $key = String::random(); - $value = String::random(); - - $this->cache->set($key, $value); - - $this->assertEquals($value, $this->cache->get($key)); - } - - public function testSetAndGetMultiple() - { - $keys = $values = $expected = []; - - for ($i = 0; $i < 5; $i++) - { - $keys[] = String::random(); - $values[] = String::random(); - } - - foreach ($keys as $key => $key_name) - { - $value = $values[$key]; - $expected['NS-' . strtoupper($key_name)] = $value; - $this->cache->set($key_name, $value); - } - - $this->assertEquals($expected, $this->cache->get($keys)); - } - - public function testDelete() - { - $key = String::random(); - $value = String::random(); - - $this->cache->set($key, $value); - $this->cache->delete($key); - - $this->assertFalse($this->cache->get($key)); - } - - public function testIncrement() - { - $key = String::random(); - - $this->assertFalse($this->cache->increment($key)); - - $this->cache->set($key, 1); - - $this->assertEquals(2, $this->cache->increment($key)); - $this->assertEquals(3, $this->cache->increment($key)); - $this->assertEquals(4, $this->cache->increment($key)); - } - - // Doesn't do much but test that the destructor doesn't explode - public function testDestructor() - { - $this->cache->__destruct(); - } -} - diff --git a/tests/classes/ConfigTest.php b/tests/classes/ConfigTest.php deleted file mode 100644 index e16c8d1..0000000 --- a/tests/classes/ConfigTest.php +++ /dev/null @@ -1,161 +0,0 @@ -config = Config::getInstance(); - setupConfig([]); - - $_SERVER['REQUEST_METHOD'] = 'GET'; - } - - public function testConfigProperty() - { - $config = new Config(); - - $this->assertTrue(PHPUnit_Framework_Assert::readAttribute($config, 'config')); - } - - public function testInstanceOf() - { - $this->assertInstanceOf('Config', $this->config); - } - - public function testUndefined() - { - $this->assertFalse($this->config->undefined); - } - - public function testDefinedEnvironment() - { - setUpConfig([ - 'environment' => 'local', - ]); - - $config = new Config(); - - $this->assertEquals('local', $config->environment); - } - - public function testMultipleEnvironmentsByIP() - { - setUpConfig([ - 'environments' => [ - 'local' => '127.0.0.1', - 'prod' => '123.456.789.0', - ], - ]); - - $config = new Config(); - - $this->assertEquals('local', $config->environment); - } - - public function testMultipleEnvironmentsByRegex() - { - setUpConfig([ - 'environments' => [ - 'local' => '/^local\.testsite\.com$/', - 'prod' => '/^testsite\.com$/', - ], - ]); - - $config = new Config(); - - $this->assertEquals('prod', $config->environment); - } - - public function testCLIEnvironment() - { - unset($_SERVER['REQUEST_METHOD']); - $_SERVER['argv'][1] = 'prod'; - - setUpConfig([ - 'environments' => [ - 'local' => '127.0.0.1', - 'prod' => '123.456.789.0', - ], - ]); - - $config = new Config(); - - $this->assertEquals('prod', $config->environment); - } - - /** - * @expectedException Exception - * @expectedExceptionMessage You must pass an environment (e.g. php script.php ) - */ - public function testCLIMissingEnvironment() - { - unset($_SERVER['REQUEST_METHOD']); - $_SERVER['argc'] = 1; - - setUpConfig(['environments' => []]); - - $config = new Config(); - } - - public function testProfiler() - { - setUpConfig([ - 'environment' => 'local', - 'pickles' => ['profiler' => true], - ]); - - $config = new Config(); - - $this->assertTrue($config->pickles['profiler']); - } - - public function testProfilerArray() - { - setUpConfig([ - 'environment' => 'local', - 'pickles' => ['profiler' => ['objects', 'timers']], - ]); - - $config = new Config(); - - $this->assertEquals('objects,timers', $config->pickles['profiler']); - } - - public function testSecurityConstant() - { - setUpConfig([ - 'environment' => 'local', - 'security' => ['levels' => [10 => 'level']], - ]); - - $config = new Config(); - - $this->assertEquals(10, SECURITY_LEVEL_USER); - } - - /** - * @expectedException Exception - * @expectedExceptionMessage The constant SECURITY_LEVEL_LEVEL is already defined - */ - public function testSecurityConstantAlreadyDefined() - { - setUpConfig([ - 'environment' => 'local', - 'security' => ['levels' => [10 => 'level']], - ]); - - $config = new Config(); - - $this->assertEquals(10, SECURITY_LEVEL_USER); - } - - // This test is just for coverage - public function testConfigArrayMissing() - { - file_put_contents(SITE_PATH . 'config.php', ''); - new Config(); - } -} - diff --git a/tests/classes/ControllerTest.php b/tests/classes/ControllerTest.php deleted file mode 100644 index cdb99e2..0000000 --- a/tests/classes/ControllerTest.php +++ /dev/null @@ -1,358 +0,0 @@ -config = Config::getInstance(); - $this->config->data['pickles']['disabled'] = false; - $this->config->data['pickles']['profiler'] = false; - $this->config->data['security']['levels'][10] = 'USER'; - $this->config->data['security']['levels'][20] = 'ADMIN'; - - setUpRequest('home'); - - $module = 'config->data['pickles']['disabled'] = true; - - $this->expectOutputRegex('/Test Server is currently down for maintenance/'); - - new Controller(); - } - - public function testCustomSiteDown() - { - $this->config->data['pickles']['disabled'] = true; - - file_put_contents(SITE_TEMPLATE_PATH . '__shared/maintenance.phtml', '

Custom Down for Maintenance

'); - - new Controller(); - - $this->expectOutputRegex('/

Custom Down for Maintenance<\/h1>/'); - } - - public function testAttributesInURI() - { - setUpRequest('home/id:123'); - - new Controller(); - - $this->assertEquals(123, Browser::get('id')); - - setUpRequest('home/id:456/foo:bar'); - - new Controller(); - - // Compensates for 2 empty template executions of the Controller - $this->expectOutputString('[][]'); - $this->assertEquals(456, Browser::get('id')); - $this->assertEquals('bar', Browser::get('foo')); - } - - public function testUpperCaseURI() - { - setUpRequest('TESTING'); - - new Controller(); - - $this->assertTrue(in_array('Location: /testing', xdebug_get_headers())); - } - - public function testForceSecure() - { - setUpRequest('secure'); - - $module = 'assertTrue(in_array('Location: https://testsite.com/secure', xdebug_get_headers())); - } - - public function testForceInsecure() - { - setUpRequest('insecure'); - $_SERVER['HTTPS'] = 'on'; - - $module = 'assertTrue(in_array('Location: http://testsite.com/insecure', xdebug_get_headers())); - } - - public function testNotAuthenticated() - { - setUpRequest('notauth'); - - $module = 'expectOutputString('[]'); - - $this->assertTrue(in_array('Location: http://testsite.com/login', xdebug_get_headers())); - } - - public function testSecurityArray() - { - setUpRequest('securityarray'); - - $module = 'expectOutputString('[]'); - - $this->assertTrue(in_array('Location: http://testsite.com/login', xdebug_get_headers())); - } - - public function testSecurityArrayTypeString() - { - setUpRequest('securityarraytypestring'); - - $module = ' "IS", "level" => SECURITY_LEVEL_USER]; }'; - - file_put_contents(SITE_MODULE_PATH . 'securityarraytypestring.php', $module); - - new Controller(); - - // Compensates for an empty template due to exit() being skipped - $this->expectOutputString('[]'); - - $this->assertTrue(in_array('Location: http://testsite.com/login', xdebug_get_headers())); - } - - public function testSecurityArrayTypeArray() - { - setUpRequest('securityarraytypearray'); - - $module = ' "IS", "level" => [SECURITY_LEVEL_USER, SECURITY_LEVEL_ADMIN]]; }'; - - file_put_contents(SITE_MODULE_PATH . 'securityarraytypearray.php', $module); - - new Controller(); - - // Compensates for an empty template due to exit() being skipped - $this->expectOutputString('[]'); - - $this->assertTrue(in_array('Location: http://testsite.com/login', xdebug_get_headers())); - } - - public function testSecurityArrayTypeBetween() - { - setUpRequest('securityarraytypebetween'); - - $module = ' "BETWEEN", "levels" => [SECURITY_LEVEL_USER, SECURITY_LEVEL_ADMIN]]; }'; - - file_put_contents(SITE_MODULE_PATH . 'securityarraytypebetween.php', $module); - - new Controller(); - - // Compensates for an empty template due to exit() being skipped - $this->expectOutputString('[]'); - - $this->assertTrue(in_array('Location: http://testsite.com/login', xdebug_get_headers())); - } - - public function testSecurityArrayTypeHas() - { - setUpRequest('securityarraytypehas'); - - $module = ' "HAS", "level" => SECURITY_LEVEL_USER]; }'; - - file_put_contents(SITE_MODULE_PATH . 'securityarraytypehas.php', $module); - - new Controller(); - - // Compensates for an empty template due to exit() being skipped - $this->expectOutputString('[]'); - - $this->assertTrue(in_array('Location: http://testsite.com/login', xdebug_get_headers())); - } - - public function testNotAuthenticatedPOST() - { - setUpRequest('notauthpost', 'POST'); - - $module = 'expectOutputRegex('/You are not properly authenticated/'); - } - - public function testAuthenticated() - { - setUpRequest('auth'); - - $module = ' "bar"]; }' - . '}'; - - file_put_contents(SITE_MODULE_PATH . 'auth.php', $module); - - Security::login(1, 10, 'USER'); - new Controller(); - - $this->expectOutputString('{"foo":"bar"}'); - } - - public function testRoleDefaultMethod() - { - setUpRequest('rolemethod'); - - $module = ' "bar"]; }' - . 'public function __default_USER() { return ["user" => "me"]; }' - . '}'; - - file_put_contents(SITE_MODULE_PATH . 'rolemethod.php', $module); - - Security::login(1, 10, 'USER'); - new Controller(); - - $this->expectOutputString('{"user":"me"}'); - } - - public function testValidRequestMethod() - { - setUpRequest('validrequestmethod'); - - $module = ' "bar"]; }' - . '}'; - - file_put_contents(SITE_MODULE_PATH . 'validrequestmethod.php', $module); - - new Controller(); - - $this->expectOutputString('{"foo":"bar"}'); - } - - public function testInvalidRequestMethod() - { - setUpRequest('invalidrequestmethod'); - - $module = ' "bar"]; }' - . '}'; - - file_put_contents(SITE_MODULE_PATH . 'invalidrequestmethod.php', $module); - - new Controller(); - - $this->expectOutputString('{"status":"error","message":"There was a problem with your request method."}'); - } - - public function testValidationErrors() - { - setUpRequest('validationerrors'); - - $module = ' "bar"]; }' - . '}'; - - file_put_contents(SITE_MODULE_PATH . 'validationerrors.php', $module); - - new Controller(); - - $this->expectOutputString('{"status":"error","message":"The test field is required."}'); - } - - public function testError404() - { - setUpRequest('fourohfour'); - - new Controller(); - - $this->assertTrue(in_array('Status: 404 Not Found', xdebug_get_headers())); - $this->expectOutputRegex('/

Not Found<\/h1>/'); - } - - public function testCustomError404() - { - setUpRequest('customfourohfour'); - - file_put_contents(SITE_TEMPLATE_PATH . '__shared/404.phtml', '

Custom Not Found

'); - - new Controller(); - - $this->assertTrue(in_array('Status: 404 Not Found', xdebug_get_headers())); - $this->expectOutputRegex('/

Custom Not Found<\/h1>/'); - } - - public function testProfilerOutput() - { - $this->config->data['pickles']['profiler'] = true; - - $this->expectOutputRegex('/id="pickles-profiler"/'); - - new Controller(); - } - - public function testTwoValidTemplates() - { - $this->config->data['pickles']['profiler'] = true; - - setUpRequest('validtemplates'); - - $module = 'child template'); - - // Vim syntax highlighting borks unless ----v - $child = 'template; ?' . '>' . "\n"; - - $html = << - - -

parent template

- {$child} - - -HTML; - - file_put_contents(SITE_TEMPLATE_PATH . '__shared/index.phtml', $html); - - new Controller(); - - $this->expectOutputRegex('/^ - - -

parent template<\/h1> -
child template<\/div> -<\/body> -<\/html>.+