Skip to content

Commit a92e081

Browse files
committed
Added SessionHandler and Filesystem adapter
0 parents  commit a92e081

12 files changed

+415
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/vendor/
2+
composer.lock
3+

.gush.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Gush configuration file, any comments will be lost.
2+
repo_adapter: github
3+
issue_tracker: github
4+
repo_org: php-cache
5+
repo_name: filesystem-adapter
6+
issue_project_org: php-cache
7+
issue_project_name: filesystem-adapter
8+
meta-header: "This file is part of php-cache\\filesystem-adapter package.\n\n(c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]> \n\nThis source file is subject to the MIT license that is bundled\nwith this source code in the file LICENSE."
9+
pr_type:
10+
- feature
11+
- bugfix
12+
- refactor
13+
- tests
14+
- remove
15+
- style
16+
- documentation
17+
- security
18+
table-pr:
19+
fixed_tickets: ['Fixed Tickets', '']

.travis.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
language: php
2+
php:
3+
- 7.0
4+
- 5.6
5+
- 5.5
6+
- hhvm
7+
8+
sudo: false
9+
10+
matrix:
11+
fast_finish: true
12+
13+
before_install:
14+
- if [[ $TRAVIS_PHP_VERSION != 'hhvm' ]]; then phpenv config-rm xdebug.ini; fi;
15+
- pip install --user codecov
16+
17+
before_script:
18+
- travis_retry composer self-update
19+
- travis_retry composer install --prefer-source --no-interaction
20+
21+
script:
22+
- php -dzend_extension=xdebug.so vendor/bin/phpunit --coverage-clover=coverage.xml
23+
24+
after_success:
25+
- codecov

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Aaron Scherer
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Filesystem PSR-6 Cache pool
2+
[![Latest Stable Version](https://poser.pugx.org/cache/filesystem-adapter/v/stable)](https://packagist.org/packages/cache/filesystem-adapter) [![codecov.io](https://codecov.io/github/php-cache/filesystem-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/filesystem-adapter?branch=master) [![Build Status](https://travis-ci.org/php-cache/filesystem-adapter.svg?branch=master)](https://travis-ci.org/php-cache/filesystem-adapter) [![Total Downloads](https://poser.pugx.org/cache/filesystem-adapter/downloads)](https://packagist.org/packages/cache/filesystem-adapter) [![Monthly Downloads](https://poser.pugx.org/cache/filesystem-adapter/d/monthly.png)](https://packagist.org/packages/cache/filesystem-adapter) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
3+
4+
This is a PSR-6 cache implementation for Filesystem. It is a part of the PHP Cache organization. To read about
5+
features like tagging and hierarchy support please read the shared documentation at [www.php-cache.com](http://www.php-cache.com).
6+
7+
This implementation is using the excellent [Flysystem](http://flysystem.thephpleague.com/).
8+
9+
### Install
10+
11+
```bash
12+
composer require cache/filesystem-adapter
13+
```
14+
15+
### Configure
16+
17+
To create an instance of `FilesystemCachePool` you need to configure a `Filesystem` and its adapter.
18+
19+
```php
20+
use League\Flysystem\Adapter\Local;
21+
use League\Flysystem\Filesystem;
22+
use Cache\Adapter\Filesystem\FilesystemCachePool;
23+
24+
$filesystemAdapter = new Local(__DIR__.'/');
25+
$filesystem = new Filesystem($filesystemAdapter);
26+
27+
$pool = new FilesystemCachePool($filesystem);
28+
```

composer.json

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"name": "cache/filesystem-adapter",
3+
"description": "A PSR-6 cache implementation using filesystem. This implementation supports tags",
4+
"type": "library",
5+
"license": "MIT",
6+
"minimum-stability": "stable",
7+
"keywords":
8+
[
9+
"cache",
10+
"psr-6",
11+
"filesystem",
12+
"tag"
13+
],
14+
"homepage": "https://github.com/php-cache/filesystem-adapter",
15+
"authors":
16+
[
17+
{
18+
"name": "Aaron Scherer",
19+
"email": "[email protected]",
20+
"homepage": "https://github.com/aequasi"
21+
},
22+
{
23+
"name": "Tobias Nyholm",
24+
"email": "[email protected]",
25+
"homepage": "https://github.com/nyholm"
26+
}
27+
],
28+
"require":
29+
{
30+
"php": "^5.5|^7.0",
31+
"psr/cache": "~1.0",
32+
"cache/adapter-common": "^0.2",
33+
"cache/taggable-cache": "^0.3",
34+
"league/flysystem": "^1.0"
35+
},
36+
"require-dev":
37+
{
38+
"phpunit/phpunit": "^5.1|^4.0",
39+
"cache/integration-tests": "^0.7"
40+
},
41+
"provide":
42+
{
43+
"psr/cache-implementation": "~1.0"
44+
},
45+
"autoload":
46+
{
47+
"psr-4": {
48+
"Cache\\Adapter\\Filesystem\\": "src/"
49+
}
50+
},
51+
"autoload-dev":
52+
{
53+
"psr-4": {
54+
"Cache\\Adapter\\Filesystem\\Tests\\": "tests/"
55+
}
56+
}
57+
}

phpunit.xml.dist

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<phpunit backupGlobals="false"
4+
backupStaticAttributes="false"
5+
colors="true"
6+
convertErrorsToExceptions="true"
7+
convertNoticesToExceptions="true"
8+
convertWarningsToExceptions="true"
9+
processIsolation="false"
10+
stopOnFailure="false"
11+
syntaxCheck="false"
12+
bootstrap="vendor/autoload.php"
13+
>
14+
<testsuites>
15+
<testsuite name="Main Test Suite">
16+
<directory>./tests/</directory>
17+
</testsuite>
18+
</testsuites>
19+
20+
<logging>
21+
<log type="coverage-text" target="php://stdout"/>
22+
<log type="coverage-html" target="./coverageReport"/>
23+
</logging>
24+
25+
<groups>
26+
<exclude>
27+
<group>benchmark</group>
28+
</exclude>
29+
</groups>
30+
31+
<filter>
32+
<whitelist>
33+
<directory>src/</directory>
34+
</whitelist>
35+
</filter>
36+
</phpunit>

src/FilesystemCachePool.php

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<?php
2+
3+
/*
4+
* This file is part of php-cache\filesystem-adapter package.
5+
*
6+
* (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
7+
*
8+
* This source file is subject to the MIT license that is bundled
9+
* with this source code in the file LICENSE.
10+
*/
11+
12+
namespace Cache\Adapter\Filesystem;
13+
14+
use Cache\Adapter\Common\AbstractCachePool;
15+
use Cache\Adapter\Common\Exception\InvalidArgumentException;
16+
use League\Flysystem\FileNotFoundException;
17+
use League\Flysystem\Filesystem;
18+
use Psr\Cache\CacheItemInterface;
19+
20+
/**
21+
* @author Tobias Nyholm <[email protected]>
22+
*/
23+
class FilesystemCachePool extends AbstractCachePool
24+
{
25+
const CACHE_PATH = 'cache';
26+
/**
27+
* @type Filesystem
28+
*/
29+
private $filesystem;
30+
31+
/**
32+
* @param Filesystem $filesystem
33+
*/
34+
public function __construct(Filesystem $filesystem)
35+
{
36+
$this->filesystem = $filesystem;
37+
$this->filesystem->createDir(self::CACHE_PATH);
38+
}
39+
40+
protected function fetchObjectFromCache($key)
41+
{
42+
$file = $this->getFilePath($key);
43+
if (!$this->filesystem->has($file)) {
44+
return [false, null];
45+
}
46+
47+
$data = unserialize($this->filesystem->read($file));
48+
if ($data[0] !== null && time() > $data[0]) {
49+
$this->clearOneObjectFromCache($key);
50+
51+
return [false, null];
52+
}
53+
54+
return [true, $data[1]];
55+
}
56+
57+
protected function clearAllObjectsFromCache()
58+
{
59+
$this->filesystem->deleteDir(self::CACHE_PATH);
60+
$this->filesystem->createDir(self::CACHE_PATH);
61+
62+
return true;
63+
}
64+
65+
protected function clearOneObjectFromCache($key)
66+
{
67+
try {
68+
return $this->filesystem->delete($this->getFilePath($key));
69+
} catch (FileNotFoundException $e) {
70+
return true;
71+
}
72+
}
73+
74+
protected function storeItemInCache($key, CacheItemInterface $item, $ttl)
75+
{
76+
$file = $this->getFilePath($key);
77+
if ($this->filesystem->has($file)) {
78+
$this->filesystem->delete($file);
79+
}
80+
81+
return $this->filesystem->write($file, serialize([
82+
($ttl === null ? null : time() + $ttl),
83+
$item->get(),
84+
]));
85+
}
86+
87+
/**
88+
* @param string $key
89+
*
90+
* @throws InvalidArgumentException
91+
*
92+
* @return string
93+
*/
94+
private function getFilePath($key)
95+
{
96+
if (!preg_match('|^[a-zA-Z0-9_\.! ]+$|', $key)) {
97+
throw new InvalidArgumentException(sprintf('Invalid key "%s". Valid keys must match [a-zA-Z0-9_\.! ].', $key));
98+
}
99+
100+
return sprintf('%s/%s', self::CACHE_PATH, $key);
101+
}
102+
}

tests/CreatePoolTrait.php

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?php
2+
3+
/*
4+
* This file is part of php-cache\filesystem-adapter package.
5+
*
6+
* (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
7+
*
8+
* This source file is subject to the MIT license that is bundled
9+
* with this source code in the file LICENSE.
10+
*/
11+
12+
namespace Cache\Adapter\Filesystem\Tests;
13+
14+
use Cache\Adapter\Filesystem\FilesystemCachePool;
15+
use League\Flysystem\Adapter\Local;
16+
use League\Flysystem\Filesystem;
17+
18+
trait CreatePoolTrait
19+
{
20+
/**
21+
* @type Filesystem
22+
*/
23+
private $filesystem;
24+
25+
public function createCachePool()
26+
{
27+
return new FilesystemCachePool($this->getFilesystem());
28+
}
29+
30+
private function getFilesystem()
31+
{
32+
if ($this->filesystem === null) {
33+
$this->filesystem = new Filesystem(new Local(__DIR__.'/'));
34+
}
35+
36+
return $this->filesystem;
37+
}
38+
}

tests/FilesystemCachePoolTest.php

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
3+
/*
4+
* This file is part of php-cache\filesystem-adapter package.
5+
*
6+
* (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
7+
*
8+
* This source file is subject to the MIT license that is bundled
9+
* with this source code in the file LICENSE.
10+
*/
11+
12+
namespace Cache\Adapter\Filesystem\Tests;
13+
14+
/**
15+
* @author Tobias Nyholm <[email protected]>
16+
*/
17+
class FilesystemCachePoolTest extends \PHPUnit_Framework_TestCase
18+
{
19+
use CreatePoolTrait;
20+
21+
/**
22+
* @expectedException \Psr\Cache\InvalidArgumentException
23+
*/
24+
public function testInvalidKey()
25+
{
26+
$pool = $this->createCachePool();
27+
28+
$pool->getItem('test%string')->get();
29+
}
30+
31+
public function testCleanupOnExpire()
32+
{
33+
$pool = $this->createCachePool();
34+
35+
$item = $pool->getItem('test_ttl_null');
36+
$item->set('data');
37+
$item->expiresAt(new \DateTime('now'));
38+
$pool->save($item);
39+
$this->assertTrue($this->getFilesystem()->has('cache/test_ttl_null'));
40+
41+
sleep(1);
42+
43+
$item = $pool->getItem('test_ttl_null');
44+
$this->assertFalse($item->isHit());
45+
$this->assertFalse($this->getFilesystem()->has('cache/test_ttl_null'));
46+
}
47+
}

0 commit comments

Comments
 (0)