+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function close() + { + return true; + } + + /** + * Destroy a session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.destroy.php + * @param string $session_id the session ID being destroyed + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function destroy($session_id) + { + $this->files->delete($this->path . '/' . $session_id); + return true; + } + + /** + * Cleanup old sessions. + * + * @see https://php.net/manual/en/sessionhandlerinterface.gc.php + * @param int $maxlifetime+ * Sessions that have not updated for + * the last maxlifetime seconds will be removed. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function gc($maxlifetime) + { + $files = Finder::create() + ->in($this->path) + ->files() + ->ignoreDotFiles(true) + ->date('<= now - ' . $maxlifetime . ' seconds'); + + /** @var \SplFileInfo $file */ + foreach ($files as $file) { + $this->files->delete($file->getRealPath()); + } + return true; + } + + /** + * Initialize session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.open.php + * @param string $save_path the path where to store/retrieve the session + * @param string $name the session name + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function open($save_path, $name) + { + return true; + } + + /** + * Read session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.read.php + * @param string $session_id the session id to read data for + * @return string+ * Returns an encoded string of the read data. + * If nothing was read, it must return an empty string. + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function read($session_id) + { + if ($this->files->isFile($path = $this->path . '/' . $session_id)) { + if ($this->files->lastModified($path) >= Carbon::now()->subMinutes($this->minutes)->getTimestamp()) { + return $this->files->sharedGet($path); + } + } + + return ''; + } + + /** + * Write session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.write.php + * @param string $session_id the session id + * @param string $session_data+ * The encoded session data. This data is the + * result of the PHP internally encoding + * the $_SESSION superglobal to a serialized + * string and passing it as this parameter. + * Please note sessions use an alternative serialization method. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function write($session_id, $session_data) + { + $this->files->put($this->path . '/' . $session_id, $session_data, true); + + return true; + } +} diff --git a/src/session/src/Handler/FileHandlerFactory.php b/src/session/src/Handler/FileHandlerFactory.php new file mode 100644 index 000000000..b118358b1 --- /dev/null +++ b/src/session/src/Handler/FileHandlerFactory.php @@ -0,0 +1,31 @@ +get(ConfigInterface::class); + $path = $config->get('session.options.path'); + $minutes = $config->get('session.options.gc_maxlifetime', 1200); + if (! $path) { + throw new \InvalidArgumentException('Invalid session path.'); + } + return new FileHandler($container->get(Filesystem::class), $path, $minutes); + } +} diff --git a/src/session/src/Handler/NullHandler.php b/src/session/src/Handler/NullHandler.php new file mode 100644 index 000000000..96243d572 --- /dev/null +++ b/src/session/src/Handler/NullHandler.php @@ -0,0 +1,125 @@ + + * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + * + * @since 5.4.0 + */ + public function close() + { + return true; + } + + /** + * Destroy a session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.destroy.php + * @param string $session_id the session ID being destroyed + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function destroy($session_id) + { + return true; + } + + /** + * Cleanup old sessions. + * + * @see https://php.net/manual/en/sessionhandlerinterface.gc.php + * @param int $maxlifetime+ * Sessions that have not updated for + * the last maxlifetime seconds will be removed. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function gc($maxlifetime) + { + return true; + } + + /** + * Initialize session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.open.php + * @param string $save_path the path where to store/retrieve the session + * @param string $name the session name + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function open($save_path, $name) + { + return true; + } + + /** + * Read session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.read.php + * @param string $session_id the session id to read data for + * @return string+ * Returns an encoded string of the read data. + * If nothing was read, it must return an empty string. + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function read($session_id) + { + return ''; + } + + /** + * Write session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.write.php + * @param string $session_id the session id + * @param string $session_data+ * The encoded session data. This data is the + * result of the PHP internally encoding + * the $_SESSION superglobal to a serialized + * string and passing it as this parameter. + * Please note sessions use an alternative serialization method. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function write($session_id, $session_data) + { + return true; + } +} diff --git a/src/session/src/Handler/RedisHandler.php b/src/session/src/Handler/RedisHandler.php new file mode 100644 index 000000000..a0c479f35 --- /dev/null +++ b/src/session/src/Handler/RedisHandler.php @@ -0,0 +1,147 @@ +redis = $redis; + $this->gcMaxLifeTime = $gcMaxLifeTime; + } + + /** + * Close the session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.close.php + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function close() + { + return true; + } + + /** + * Destroy a session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.destroy.php + * @param string $session_id the session ID being destroyed + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function destroy($session_id) + { + $this->redis->del($session_id); + return true; + } + + /** + * Cleanup old sessions. + * + * @see https://php.net/manual/en/sessionhandlerinterface.gc.php + * @param int $maxlifetime+ * Sessions that have not updated for + * the last maxlifetime seconds will be removed. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function gc($maxlifetime) + { + return true; + } + + /** + * Initialize session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.open.php + * @param string $save_path the path where to store/retrieve the session + * @param string $name the session name + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function open($save_path, $name) + { + return true; + } + + /** + * Read session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.read.php + * @param string $session_id the session id to read data for + * @return string+ * Returns an encoded string of the read data. + * If nothing was read, it must return an empty string. + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function read($session_id) + { + return $this->redis->get($session_id) ?: ''; + } + + /** + * Write session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.write.php + * @param string $session_id the session id + * @param string $session_data+ * The encoded session data. This data is the + * result of the PHP internally encoding + * the $_SESSION superglobal to a serialized + * string and passing it as this parameter. + * Please note sessions use an alternative serialization method. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function write($session_id, $session_data) + { + return (bool) $this->redis->setEx($session_id, (int) $this->gcMaxLifeTime, $session_data); + } +} diff --git a/src/session/src/Handler/RedisHandlerFactory.php b/src/session/src/Handler/RedisHandlerFactory.php new file mode 100644 index 000000000..5d108f988 --- /dev/null +++ b/src/session/src/Handler/RedisHandlerFactory.php @@ -0,0 +1,30 @@ +get(ConfigInterface::class); + $connection = $config->get('session.options.connection'); + $gcMaxLifetime = $config->get('session.options.gc_maxlifetime', 1200); + $redisFactory = $container->get(RedisFactory::class); + $redis = $redisFactory->get($connection); + return new RedisHandler($redis, $gcMaxLifetime); + } +} diff --git a/src/session/src/Middleware/SessionMiddleware.php b/src/session/src/Middleware/SessionMiddleware.php new file mode 100644 index 000000000..3350098d8 --- /dev/null +++ b/src/session/src/Middleware/SessionMiddleware.php @@ -0,0 +1,137 @@ +sessionManager = $sessionManager; + $this->config = $config; + } + + /** + * Process an incoming server request. + * Processes an incoming server request in order to produce a response. + * If unable to produce the response itself, it may delegate to the provided + * request handler to do so. + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + if (! $this->isSessionAvailable()) { + return $handler->handle($request); + } + + $session = $this->sessionManager->start($request); + + $response = $handler->handle($request); + + $this->storeCurrentUrl($request, $session); + + $response = $this->addCookieToResponse($request, $response, $session); + + // @TODO Use defer + $this->sessionManager->end($session); + + return $response; + } + + private function isSessionAvailable(): bool + { + return $this->config->has('session.handler'); + } + + /** + * Get the URL (no query string) for the request. + */ + private function url(RequestInterface $request): string + { + return rtrim(preg_replace('/\?.*/', '', $request->getUri()), '/'); + } + + /** + * Store the current URL for the request if necessary. + */ + private function storeCurrentUrl(RequestInterface $request, SessionInterface $session) + { + if ($request->getMethod() === 'GET') { + $session->setPreviousUrl($this->fullUrl($request)); + } + } + + /** + * Get the session lifetime in seconds. + */ + private function getCookieExpirationDate(): int + { + if ($this->config->get('session.options.expire_on_close')) { + $expirationDate = 0; + } else { + $expirationDate = Carbon::now()->addMinutes(5 * 60)->getTimestamp(); + } + return $expirationDate; + } + + /** + * Add the session cookie to the response·. + */ + private function addCookieToResponse( + ServerRequestInterface $request, + ResponseInterface $response, + SessionInterface $session + ): ResponseInterface { + $uri = $request->getUri(); + $path = '/'; + $domain = $uri->getHost(); + $secure = strtolower($uri->getScheme()) === 'https'; + $httpOnly = true; + if (! method_exists($response, 'withCookie')) { + // @TODO Adapte original response object. + throw new \RuntimeException('Unsupport response object.'); + } + /* @var \Hyperf\HttpMessage\Server\Response $response */ + return $response->withCookie(new Cookie($session->getName(), $session->getId(), $this->getCookieExpirationDate(), $path, $domain, $secure, $httpOnly)); + } + + /** + * Get the full URL for the request. + */ + private function fullUrl(RequestInterface $request): string + { + $uri = $request->getUri(); + $query = $uri->getQuery(); + $question = $uri->getHost() . $uri->getPath() == '/' ? '/?' : '?'; + return $query ? $this->url($request) . $question . $query : $this->url($request); + } +} diff --git a/src/session/src/Session.php b/src/session/src/Session.php new file mode 100644 index 000000000..020059f5f --- /dev/null +++ b/src/session/src/Session.php @@ -0,0 +1,372 @@ +isValidId($id)) { + $id = $this->generateSessionId(); + } + $this->setId($id); + $this->setName($name); + $this->handler = $handler; + } + + /** + * Determine if this is a valid session ID. + */ + public function isValidId(string $id): bool + { + return is_string($id) && ctype_alnum($id) && strlen($id) === 40; + } + + /** + * Starts the session storage. + */ + public function start(): bool + { + $this->loadSession(); + + return $this->started = true; + } + + /** + * Returns the session ID. + * + * @return string The session ID + */ + public function getId(): string + { + return $this->id; + } + + /** + * Sets the session ID. + */ + public function setId(string $id): void + { + $this->id = $id; + } + + /** + * Returns the session name. + */ + public function getName(): string + { + return $this->name; + } + + /** + * Sets the session name. + */ + public function setName(string $name): void + { + $this->name = $name; + } + + /** + * Invalidates the current session. + * Clears all session attributes and flashes and regenerates the + * session and deletes the old session from persistence. + * + * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value + * will leave the system settings unchanged, 0 sets the cookie + * to expire with browser session. Time is in seconds, and is + * not a Unix timestamp. + * @return bool True if session invalidated, false if error + */ + public function invalidate(?int $lifetime = null): bool + { + $this->clear(); + + return $this->migrate(true, $lifetime); + } + + /** + * Migrates the current session to a new session id while maintaining all + * session attributes. + * + * @param bool $destroy Whether to delete the old session or leave it to garbage collection + * @param int $lifetime Sets the cookie lifetime for the session cookie. A null value + * will leave the system settings unchanged, 0 sets the cookie + * to expire with browser session. Time is in seconds, and is + * not a Unix timestamp. + * @return bool True if session migrated, false if error + */ + public function migrate(bool $destroy = false, ?int $lifetime = null): bool + { + if ($destroy) { + $this->handler->destroy($this->getId()); + } + + $this->setId($this->generateSessionId()); + + return true; + } + + /** + * Force the session to be saved and closed. + * This method is generally not required for real sessions as + * the session will be automatically saved at the end of + * code execution. + */ + public function save(): void + { + $this->ageFlashData(); + + $this->handler->write($this->getId(), $this->prepareForStorage(serialize($this->attributes))); + + $this->started = false; + } + + /** + * Checks if an attribute is defined. + * + * @param string $name The attribute name + * @return bool true if the attribute is defined, false otherwise + */ + public function has(string $name): bool + { + return Arr::exists($this->attributes, $name); + } + + /** + * Returns an attribute. + * + * @param string $name The attribute name + * @param mixed $default The default value if not found + */ + public function get(string $name, $default = null) + { + return data_get($this->attributes, $name, $default); + } + + /** + * Sets an attribute. + * + * @param mixed $value + */ + public function set(string $name, $value): void + { + data_set($this->attributes, $name, $value); + } + + /** + * Put a key / value pair or array of key / value pairs in the session. + * + * @param array|string $key + * @param null|mixed $value + */ + public function put($key, $value = null): void + { + if (! is_array($key)) { + $key = [$key => $value]; + } + + foreach ($key as $arrayKey => $arrayValue) { + Arr::set($this->attributes, $arrayKey, $arrayValue); + } + } + + /** + * Returns attributes. + */ + public function all(): array + { + return $this->attributes; + } + + /** + * Sets attributes. + */ + public function replace(array $attributes): void + { + foreach ($attributes as $name => $value) { + data_set($this->attributes, $name, $value); + } + } + + /** + * Removes an attribute, returning its value. + * + * @return mixed The removed value or null when it does not exist + */ + public function remove(string $name) + { + return Arr::pull($this->attributes, $name); + } + + /** + * Remove one or many items from the session. + * + * @param array|string $keys + */ + public function forget($keys): void + { + Arr::forget($this->attributes, $keys); + } + + /** + * Clears all attributes. + */ + public function clear(): void + { + $this->attributes = []; + } + + /** + * Checks if the session was started. + */ + public function isStarted(): bool + { + return $this->started; + } + + /** + * Get the CSRF token value. + */ + public function token(): string + { + return (string) $this->get('_token'); + } + + /** + * Regenerate the CSRF token value. + */ + public function regenerateToken(): string + { + $this->put('_token', $token = Str::random(40)); + return $token; + } + + /** + * Get the previous URL from the session. + */ + public function previousUrl(): ?string + { + $previousUrl = $this->get('_previous.url'); + if (! is_string($previousUrl)) { + $previousUrl = null; + } + return $previousUrl; + } + + /** + * Set the "previous" URL in the session. + */ + public function setPreviousUrl(string $url): void + { + $this->set('_previous.url', $url); + } + + /** + * Push a value onto a session array. + * + * @param mixed $value + */ + public function push(string $key, $value): void + { + $array = $this->get($key, []); + + $array[] = $value; + + $this->put($key, $array); + } + + /** + * Generate a new random sessoion ID. + */ + protected function generateSessionId(): string + { + return Str::random(40); + } + + /** + * Load the session data from the handler. + */ + protected function loadSession(): void + { + $this->attributes = array_merge($this->attributes, $this->readFromHandler()); + } + + /** + * Read the session data from the handler. + */ + protected function readFromHandler(): array + { + if ($data = $this->handler->read($this->getId())) { + $data = @unserialize($this->prepareForUnserialize($data)); + + if ($data !== false && ! is_null($data) && is_array($data)) { + return $data; + } + } + + return []; + } + + /** + * Prepare the raw string data from the session for unserialization. + */ + protected function prepareForUnserialize(string $data): string + { + return $data; + } + + /** + * Prepare the serialized session data for storage. + */ + protected function prepareForStorage(string $data): string + { + return $data; + } +} diff --git a/src/session/src/SessionManager.php b/src/session/src/SessionManager.php new file mode 100644 index 000000000..390f98f8a --- /dev/null +++ b/src/session/src/SessionManager.php @@ -0,0 +1,92 @@ +container = $container; + $this->config = $config; + } + + public function getSessionName(): string + { + return 'HYPERF_SESSION_ID'; + } + + public function start(ServerRequestInterface $request): SessionInterface + { + $sessionId = $this->parseSessionId($request); + // @TODO Use make() function to create Session object. + $session = new Session($this->getSessionName(), $this->buildSessionHandler(), $sessionId); + if (! $session->start()) { + throw new \RuntimeException('Start session failed.'); + } + $this->setSession($session); + return $session; + } + + public function end(SessionInterface $session): void + { + $session->save(); + } + + public function getSession(): SessionInterface + { + return Context::get(SessionInterface::class); + } + + public function setSession(SessionInterface $session): self + { + Context::set(SessionInterface::class, $session); + return $this; + } + + protected function parseSessionId(ServerRequestInterface $request): ?string + { + $cookies = $request->getCookieParams(); + foreach ($cookies as $key => $value) { + if ($key === $this->getSessionName()) { + return (string) $value; + } + } + return null; + } + + protected function buildSessionHandler(): SessionHandlerInterface + { + $handler = $this->config->get('session.handler'); + if (! $handler || ! class_exists($handler)) { + throw new \InvalidArgumentException('Invalid handler of session'); + } + return $this->container->get($handler); + } +} diff --git a/src/session/src/SessionProxy.php b/src/session/src/SessionProxy.php new file mode 100644 index 000000000..c25faee53 --- /dev/null +++ b/src/session/src/SessionProxy.php @@ -0,0 +1,214 @@ +getSession()->flash($key, $value); + } + + public function now(string $key, $value): void + { + $this->getSession()->now($key, $value); + } + + public function reflash(): void + { + $this->getSession()->reflash(); + } + + public function keep($keys = null): void + { + $this->getSession()->keep($keys); + } + + public function flashInput(array $value): void + { + $this->getSession()->flashInput($value); + } + + public function ageFlashData(): void + { + $this->getSession()->ageFlashData(); + } + + public function isValidId(string $id): bool + { + return $this->getSession()->isValidId($id); + } + + public function start(): bool + { + return $this->getSession()->start(); + } + + public function getId(): string + { + return $this->getSession()->getId(); + } + + public function setId(string $id): void + { + $this->getSession()->setId($id); + } + + public function getName(): string + { + return $this->getSession()->getName(); + } + + public function setName(string $name): void + { + $this->getSession()->setName($name); + } + + public function invalidate(?int $lifetime = null): bool + { + return $this->getSession()->invalidate($lifetime); + } + + public function migrate(bool $destroy = false, ?int $lifetime = null): bool + { + return $this->getSession->migrate($destroy, $lifetime); + } + + public function save(): void + { + $this->getSession->save(); + } + + public function has(string $name): bool + { + return $this->getSession->has($name); + } + + public function get(string $name, $default = null) + { + return $this->getSession()->get($name, $default); + } + + public function set(string $name, $value): void + { + $this->getSession()->set($name, $value); + } + + public function put($key, $value = null): void + { + $this->getSession()->put($key, $value); + } + + public function all(): array + { + return $this->getSession()->all(); + } + + public function replace(array $attributes): void + { + $this->getSession()->replace($attributes); + } + + public function remove(string $name) + { + return $this->getSession()->remove($name); + } + + public function forget($keys): void + { + $this->getSession()->forget($keys); + } + + public function clear(): void + { + $this->getSession()->clear(); + } + + public function isStarted(): bool + { + return $this->getSession()->isStarted(); + } + + public function token(): string + { + return $this->getSession()->token(); + } + + public function regenerateToken(): string + { + return $this->getSession()->regenerateToken(); + } + + public function previousUrl(): ?string + { + return $this->getSession()->previousUrl(); + } + + public function setPreviousUrl(string $url): void + { + $this->getSession()->setPreviousUrl($url); + } + + public function push(string $key, $value): void + { + $this->getSession()->push($key, $value); + } + + protected function getSession(): Session + { + return Context::get(SessionInterface::class); + } + + protected function mergeNewFlashes(array $keys): void + { + $this->getSession()->mergeNewFlashes($keys); + } + + protected function removeFromOldFlashData(array $keys): void + { + $this->getSession()->removeFromOldFlashData($keys); + } + + protected function generateSessionId(): string + { + return $this->getSession()->generateSessionId(); + } + + protected function loadSession(): void + { + $this->getSession()->loadSession(); + } + + protected function readFromHandler(): array + { + return $this->getSession()->readFromHandler(); + } + + protected function prepareForUnserialize(string $data): string + { + return $this->getSession()->prepareForUnserialize($data); + } + + protected function prepareForStorage(string $data): string + { + return $this->getSession()->prepareForStorage($data); + } +} diff --git a/src/session/tests/ConfigProviderTest.php b/src/session/tests/ConfigProviderTest.php new file mode 100644 index 000000000..35a939856 --- /dev/null +++ b/src/session/tests/ConfigProviderTest.php @@ -0,0 +1,30 @@ +assertArrayHasKey('annotations', $provider()); + $this->assertArrayHasKey('publish', $provider()); + } +} diff --git a/src/session/tests/FileHandlerTest.php b/src/session/tests/FileHandlerTest.php new file mode 100644 index 000000000..5c811f958 --- /dev/null +++ b/src/session/tests/FileHandlerTest.php @@ -0,0 +1,73 @@ +assertTrue($handler->open('', '')); + $this->assertTrue($handler->close('', '')); + + $id = Str::random(40); + $data = [ + 'int' => 1, + 'true' => true, + 'false' => false, + 'float' => 1.23, + 'string' => 'foo', + 0 => 1, + 'array' => [ + 'int' => 1, + 'true' => true, + 'false' => false, + 'float' => 1.23, + 'string' => 'foo', + 0 => 1, + ], + ]; + $this->assertTrue($handler->write($id, serialize($data))); + $this->assertSame($data, unserialize($handler->read($id))); + $this->assertFileExists('/tmp/' . $id); + $handler->destroy($id); + $this->assertFileNotExists('/tmp/' . $id); + } + + public function testReadNotExistsSessionId() + { + $handler = new FileHandler(new Filesystem(), $path = '/tmp', 10); + $this->assertSame('', $handler->read('not-exist')); + } + + public function testGc() + { + $handler = new FileHandler(new Filesystem(), $path = __DIR__ . '/runtime/session', 1); + $id = Str::random(40); + $handler->write($id, 'foo'); + sleep(1); + $handler->gc(1); + $this->assertFileNotExists($path . '/' . $id); + } +} diff --git a/src/session/tests/SessionManagerTest.php b/src/session/tests/SessionManagerTest.php new file mode 100644 index 000000000..203176a9d --- /dev/null +++ b/src/session/tests/SessionManagerTest.php @@ -0,0 +1,60 @@ +setSession($mockSession = Mockery::mock(Session::class)); + $this->assertInstanceOf(SessionManager::class, $sessionManager); + + $session = $sessionManager->getSession(); + $this->assertInstanceOf(Session::class, $session); + $this->assertSame($mockSession, $session); + } + + public function testParseSessionId() + { + $request = new Request('get', '/'); + $sessionManager = new SessionManager(Mockery::mock(ContainerInterface::class), Mockery::mock(ConfigInterface::class)); + $reflectionClass = new ReflectionClass(SessionManager::class); + $parseSessionIdMethod = $reflectionClass->getMethod('parseSessionId'); + $parseSessionIdMethod->setAccessible(true); + $id = Str::random(40); + $this->assertSame($id, $parseSessionIdMethod->invoke($sessionManager, $request->withCookieParams([ + 'HYPERF_SESSION_ID' => $id, + ]))); + $this->assertSame('123', $parseSessionIdMethod->invoke($sessionManager, $request->withCookieParams([ + 'HYPERF_SESSION_ID' => 123, + ]))); + $this->assertNull($parseSessionIdMethod->invoke($sessionManager, $request->withCookieParams([ + 'foo' => 'bar', + ]))); + } +} diff --git a/src/session/tests/SessionMiddlewareTest.php b/src/session/tests/SessionMiddlewareTest.php new file mode 100644 index 000000000..0a0882d52 --- /dev/null +++ b/src/session/tests/SessionMiddlewareTest.php @@ -0,0 +1,112 @@ +withCookieParams(['HYPERF_SESSION_ID' => 'foo123']); + $requestHandler = Mockery::mock(RequestHandlerInterface::class); + $requestHandler->shouldReceive('handle')->andReturn(new Response()); + + $container = Mockery::mock(ContainerInterface::class); + $container->shouldReceive('has')->with(SessionInterface::class)->andReturnTrue(); + $container->shouldReceive('has')->with(FileHandler::class)->andReturnTrue(); + $fileHandler = new FileHandler(new Filesystem(), '/tmp', 10); + $container->shouldReceive('get')->with(FileHandler::class)->andReturn($fileHandler); + /** @var Session $session */ + $session = new Session('HYPERF_SESSION_ID', $fileHandler); + $container->shouldReceive('get')->with(SessionInterface::class)->andReturn($session); + $container->shouldReceive('get')->with(FooHandler::class)->andReturn(new FooHandler()); + + $config = Mockery::mock(ConfigInterface::class); + $config->shouldReceive('get')->with('session.handler')->andReturn(FooHandler::class); + $config->shouldReceive('has')->with('session.handler')->andReturn(true); + $config->shouldReceive('get')->with('session.options.expire_on_close')->andReturn(1); + $sessionManager = new SessionManager($container, $config); + $middleware = new SessionMiddleware($sessionManager, $config); + $response = $middleware->process($request, $requestHandler); + + $this->assertInstanceOf(ResponseInterface::class, $response); + $this->assertInstanceOf(SessionInterface::class, $session = Context::get(SessionInterface::class)); + $this->assertIsString($session->getId()); + $this->assertTrue(ctype_alnum($session->getId())); + $this->assertSame(40, strlen($session->getId())); + $this->assertArrayHasKey('', $response->getCookies()); + $this->assertArrayHasKey('/', $response->getCookies()['']); + $this->assertArrayHasKey($session->getName(), $response->getCookies()['']['/']); + $this->assertInstanceOf(Cookie::class, $response->getCookies()['']['/'][$session->getName()]); + /** @var Cookie $cookie */ + $cookie = $response->getCookies()['']['/'][$session->getName()]; + $this->assertSame('HYPERF_SESSION_ID', $cookie->getName()); + $this->assertSame($session->getId(), $cookie->getValue()); + $this->assertSame('/', $cookie->getPath()); + $this->assertSame(0, $cookie->getExpiresTime()); + } + + public function testSessionWithExpiresTime() + { + $request = new Request('GET', '/test'); + $request = $request->withCookieParams(['HYPERF_SESSION_ID' => 'foo123']); + $requestHandler = Mockery::mock(RequestHandlerInterface::class); + $requestHandler->shouldReceive('handle')->andReturn(new Response()); + + $container = Mockery::mock(ContainerInterface::class); + $container->shouldReceive('has')->with(SessionInterface::class)->andReturnTrue(); + $container->shouldReceive('has')->with(FileHandler::class)->andReturnTrue(); + $fileHandler = new FileHandler(new Filesystem(), '/tmp', 10); + $container->shouldReceive('get')->with(FileHandler::class)->andReturn($fileHandler); + /** @var Session $session */ + $session = new Session('HYPERF_SESSION_ID', $fileHandler); + $container->shouldReceive('get')->with(SessionInterface::class)->andReturn($session); + $container->shouldReceive('get')->with(FooHandler::class)->andReturn(new FooHandler()); + + $config = Mockery::mock(ConfigInterface::class); + $config->shouldReceive('get')->with('session.handler')->andReturn(FooHandler::class); + $config->shouldReceive('has')->with('session.handler')->andReturn(true); + $config->shouldReceive('get')->with('session.options.expire_on_close')->andReturn(0); + $sessionManager = new SessionManager($container, $config); + $middleware = new SessionMiddleware($sessionManager, $config); + $time = time(); + $response = $middleware->process($request, $requestHandler); + + /** @var Cookie $cookie */ + $cookie = $response->getCookies()['']['/'][$session->getName()]; + $this->assertSame($time + (5 * 60 * 60), $cookie->getExpiresTime()); + } +} diff --git a/src/session/tests/SessionTest.php b/src/session/tests/SessionTest.php new file mode 100644 index 000000000..7e6312b94 --- /dev/null +++ b/src/session/tests/SessionTest.php @@ -0,0 +1,161 @@ +assertSame($name, $session->getName()); + $this->assertSame($id, $session->getId()); + $this->assertTrue($session->isValidId($id)); + + $session = new Session('HYPERF_SESSION_ID', new NullHandler()); + $this->assertTrue($session->isValidId($session->getId())); + } + + public function testSessionAttributes() + { + $id = Str::random(40); + $session = new Session('HYPERF_SESSION_ID', new NullHandler(), $id); + $data = [ + 'int' => 1, + 'true' => true, + 'false' => false, + 'float' => 1.23, + 'string' => 'foo', + ]; + foreach ($data as $key => $value) { + $session->set($key, $value); + } + foreach ($data as $key => $value) { + $this->assertTrue($session->has($key)); + $this->assertSame($value, $session->get($key)); + } + $this->assertFalse($session->has('not-exist')); + $this->assertSame($data, $session->all()); + + foreach ($data as $key => $value) { + $this->assertSame($value, $session->remove($key)); + } + + $session->put($data); + $this->assertSame($data, $session->all()); + + $session->clear(); + $this->assertSame([], $session->all()); + + $session->put('foo', 'bar'); + $this->assertSame(['foo' => 'bar'], $session->all()); + + $session->put($data); + $session->forget('foo'); + $this->assertSame($data, $session->all()); + + $session->replace(['int' => 2, 'foo' => 'baz']); + $this->assertSame([ + 'int' => 2, + 'true' => true, + 'false' => false, + 'float' => 1.23, + 'string' => 'foo', + 'foo' => 'baz', + ], $session->all()); + } + + public function testSessionPush() + { + $session = new Session('HYPERF_SESSION_ID', new NullHandler()); + $session->push('foo', 'bar'); + $this->assertSame([ + 'foo' => ['bar'], + ], $session->all()); + $session->push('foo', 'baz'); + $this->assertSame([ + 'foo' => ['bar', 'baz'], + ], $session->all()); + } + + public function testToken() + { + $session = new Session('HYPERF_SESSION_ID', new NullHandler()); + $this->assertSame('', $session->token()); + + $token = $session->regenerateToken(); + $this->assertSame($token, $session->token()); + $this->assertTrue($session->isValidId($token)); + } + + public function testPreviousUrl() + { + $session = new Session('HYPERF_SESSION_ID', new NullHandler()); + $url = 'http://127.0.0.1:9501/foo/bar'; + $session->setPreviousUrl($url); + $this->assertSame($url, $session->previousUrl()); + + $session->set('_previous.url', 123); + $this->assertNull($session->previousUrl()); + } + + public function testStartSession() + { + $fileHandler = new FileHandler(new Filesystem(), '/tmp', 1); + $session = new Session('HYPERF_SESSION_ID', $fileHandler); + $this->assertTrue($session->start()); + $this->assertTrue($session->isStarted()); + + $id = $session->getId(); + $session->set('foo', 'bar'); + $session->save(); + $this->assertFileExists('/tmp/' . $id); + + $session = new Session('HYPERF_SESSION_ID', $fileHandler, $id); + $session->start(); + $this->assertSame('bar', $session->get('foo')); + + $this->assertTrue($session->invalidate()); + $this->assertFileNotExists('/tmp/' . $id); + } + + public function testFlash() + { + $fileHandler = new FileHandler(new Filesystem(), '/tmp', 1); + $session = new Session('HYPERF_SESSION_ID', $fileHandler); + $id = $session->getId(); + $session->flash('foo', 'bar'); + $this->assertSame([ + 'foo' => 'bar', + '_flash' => [ + 'new' => ['foo'], + 'old' => [], + ], + ], $session->all()); + $session->save(); + + $session = new Session('HYPERF_SESSION_ID', $fileHandler, $id); + $this->assertSame([], $session->all()); + } +} diff --git a/src/session/tests/Stub/FooHandler.php b/src/session/tests/Stub/FooHandler.php new file mode 100644 index 000000000..3cb8e171d --- /dev/null +++ b/src/session/tests/Stub/FooHandler.php @@ -0,0 +1,119 @@ + + * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + * + * @since 5.4.0 + */ + public function close() + { + } + + /** + * Destroy a session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.destroy.php + * @param string $session_id the session ID being destroyed + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function destroy($session_id) + { + } + + /** + * Cleanup old sessions. + * + * @see https://php.net/manual/en/sessionhandlerinterface.gc.php + * @param int $maxlifetime+ * Sessions that have not updated for + * the last maxlifetime seconds will be removed. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function gc($maxlifetime) + { + } + + /** + * Initialize session. + * + * @see https://php.net/manual/en/sessionhandlerinterface.open.php + * @param string $save_path the path where to store/retrieve the session + * @param string $name the session name + * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function open($save_path, $name) + { + } + + /** + * Read session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.read.php + * @param string $session_id the session id to read data for + * @return string+ * Returns an encoded string of the read data. + * If nothing was read, it must return an empty string. + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function read($session_id) + { + } + + /** + * Write session data. + * + * @see https://php.net/manual/en/sessionhandlerinterface.write.php + * @param string $session_id the session id + * @param string $session_data+ * The encoded session data. This data is the + * result of the PHP internally encoding + * the $_SESSION superglobal to a serialized + * string and passing it as this parameter. + * Please note sessions use an alternative serialization method. + *
+ * @return bool+ * The return value (usually TRUE on success, FALSE on failure). + * Note this value is returned internally to PHP for processing. + *
+ * @since 5.4.0 + */ + public function write($session_id, $session_data) + { + } +} diff --git a/src/session/tests/Stub/NonSessionHandler.php b/src/session/tests/Stub/NonSessionHandler.php new file mode 100644 index 000000000..34382c327 --- /dev/null +++ b/src/session/tests/Stub/NonSessionHandler.php @@ -0,0 +1,17 @@ +localeArray($locale) - : [$locale ?: $this->locale]; + : [$locale ?: $this->locale()]; foreach ($locales as $locale) { if (! is_null($line = $this->getLine( @@ -138,7 +139,7 @@ class Translator implements TranslatorInterface */ public function getFromJson(string $key, array $replace = [], ?string $locale = null) { - $locale = $locale ?: $this->locale; + $locale = $locale ?: $this->locale(); // For JSON translations, there is only one file per locale, so we will simply load // that file and then we will be ready to check the array for the key. These are @@ -315,12 +316,22 @@ class Translator implements TranslatorInterface return $this->getLocale(); } + /** + * Get the context locale key. + */ + public function getLocaleContextKey(): string + { + return sprintf('%s::%s', TranslatorInterface::class, 'locale'); + } + /** * Get the default locale being used. */ public function getLocale(): string { - return $this->locale; + $locale = Context::get($this->getLocaleContextKey()); + + return (string) ($locale ?? $this->locale); } /** @@ -328,7 +339,7 @@ class Translator implements TranslatorInterface */ public function setLocale(string $locale) { - $this->locale = $locale; + Context::set($this->getLocaleContextKey(), $locale); } /** @@ -371,7 +382,7 @@ class Translator implements TranslatorInterface */ protected function localeForChoice(?string $locale): string { - return $locale ?: $this->locale ?: $this->fallback; + return $locale ?: $this->locale() ?: $this->fallback; } /** @@ -453,16 +464,13 @@ class Translator implements TranslatorInterface */ protected function localeArray(?string $locale): array { - return array_filter([$locale ?: $this->locale, $this->fallback]); + return array_filter([$locale ?: $this->locale(), $this->fallback]); } /** * Parse an array of basic segments. - * - * @param array $segments - * @return array */ - protected function parseBasicSegments(array $segments) + protected function parseBasicSegments(array $segments): array { // The first segment in a basic array will always be the group, so we can go // ahead and grab that segment. If there is only one total segment we are diff --git a/src/translation/tests/TranslatorTest.php b/src/translation/tests/TranslatorTest.php index dda21efe2..9ec70c08c 100755 --- a/src/translation/tests/TranslatorTest.php +++ b/src/translation/tests/TranslatorTest.php @@ -286,6 +286,25 @@ class TranslatorTest extends TestCase $this->assertEquals('foo baz', $t->getFromJson('foo :message', ['message' => 'baz'])); } + public function testSetLocale() + { + $t = new Translator($this->getLoader(), 'en'); + $this->assertEquals('en', $t->getLocale()); + parallel([ + function () use ($t) { + $this->assertEquals('en', $t->getLocale()); + $t->setLocale('zh_CN'); + $this->assertEquals('zh_CN', $t->getLocale()); + }, + function () use ($t) { + $this->assertEquals('en', $t->getLocale()); + $t->setLocale('zh_HK'); + $this->assertEquals('zh_HK', $t->getLocale()); + }, + ]); + $this->assertEquals('en', $t->getLocale()); + } + protected function getLoader() { return Mockery::mock(TranslatorLoaderInterface::class); diff --git a/src/utils/src/Exception/ParallelExecutionException.php b/src/utils/src/Exception/ParallelExecutionException.php new file mode 100644 index 000000000..22f9a0681 --- /dev/null +++ b/src/utils/src/Exception/ParallelExecutionException.php @@ -0,0 +1,46 @@ +results; + } + + public function setResults(array $results) + { + $this->results = $results; + } + + public function getThrowables() + { + return $this->throwables; + } + + public function setThrowables(array $throwables) + { + return $this->throwables = $throwables; + } +} diff --git a/src/utils/src/Parallel.php b/src/utils/src/Parallel.php index 00c50a51f..00bb2c126 100644 --- a/src/utils/src/Parallel.php +++ b/src/utils/src/Parallel.php @@ -12,6 +12,7 @@ declare(strict_types=1); namespace Hyperf\Utils; +use Hyperf\Utils\Exception\ParallelExecutionException; use Swoole\Coroutine\Channel; class Parallel @@ -45,20 +46,32 @@ class Parallel } } - public function wait(): array + public function wait(bool $throw = true): array { - $result = []; + $result = $throwables = []; $wg = new WaitGroup(); $wg->add(count($this->callbacks)); foreach ($this->callbacks as $key => $callback) { $this->concurrentChannel && $this->concurrentChannel->push(true); - Coroutine::create(function () use ($callback, $key, $wg, &$result) { - $result[$key] = call($callback); - $this->concurrentChannel && $this->concurrentChannel->pop(); - $wg->done(); + Coroutine::create(function () use ($callback, $key, $wg, &$result, &$throwables) { + try { + $result[$key] = call($callback); + } catch (\Throwable $throwable) { + $throwables[$key] = $throwable; + } finally { + $this->concurrentChannel && $this->concurrentChannel->pop(); + $wg->done(); + } }); } $wg->wait(); + if ($throw && count($throwables) > 0) { + $message = 'At least one throwable occurred during parallel execution:' . PHP_EOL . $this->formatThrowables($throwables); + $executionException = new ParallelExecutionException($message); + $executionException->setResults($result); + $executionException->setThrowables($throwables); + throw $executionException; + } return $result; } @@ -66,4 +79,16 @@ class Parallel { $this->callbacks = []; } + + /** + * Format throwables into a nice list. + */ + private function formatThrowables(array $exception): string + { + $output = ''; + foreach ($exception as $key => $value) { + $output .= \sprintf('(%s) %s: %s' . PHP_EOL, $key, get_class($value), $value->getMessage()); + } + return $output; + } } diff --git a/src/utils/src/WaitGroup.php b/src/utils/src/WaitGroup.php index 6b66e5a00..4090c0e68 100644 --- a/src/utils/src/WaitGroup.php +++ b/src/utils/src/WaitGroup.php @@ -12,39 +12,8 @@ declare(strict_types=1); namespace Hyperf\Utils; -use Swoole\Coroutine\Channel as SwooleChannel; +use Swoole\Coroutine\WaitGroup as SwooleWaitGroup; -class WaitGroup +class WaitGroup extends SwooleWaitGroup { - /** - * @var int - */ - private $counter = 0; - - /** - * @var SwooleChannel - */ - private $channel; - - public function __construct() - { - $this->channel = new SwooleChannel(); - } - - public function add(int $incr = 1): void - { - $this->counter += $incr; - } - - public function done(): void - { - $this->channel->push(true); - } - - public function wait(): void - { - while ($this->counter--) { - $this->channel->pop(); - } - } } diff --git a/src/utils/tests/ParallelTest.php b/src/utils/tests/ParallelTest.php index a92e4fce0..c78a2b202 100644 --- a/src/utils/tests/ParallelTest.php +++ b/src/utils/tests/ParallelTest.php @@ -13,6 +13,7 @@ declare(strict_types=1); namespace HyperfTest\Utils; use Hyperf\Utils\Coroutine; +use Hyperf\Utils\Exception\ParallelExecutionException; use Hyperf\Utils\Parallel; use PHPUnit\Framework\TestCase; @@ -115,6 +116,28 @@ class ParallelTest extends TestCase $this->assertEquals(count($res), 4); } + public function testParallelThrows() + { + $parallel = new Parallel(); + + $err = function () { + Coroutine::sleep(0.001); + throw new \RuntimeException('something bad happened'); + }; + + $ok = function () { + Coroutine::sleep(0.001); + return 1; + }; + + $parallel->add($err); + for ($i = 0; $i < 4; ++$i) { + $parallel->add($ok); + } + $this->expectException(ParallelExecutionException::class); + $res = $parallel->wait(); + } + public function returnCoId() { return Coroutine::id(); diff --git a/src/utils/tests/WaitGroupTest.php b/src/utils/tests/WaitGroupTest.php new file mode 100644 index 000000000..25f25f9c8 --- /dev/null +++ b/src/utils/tests/WaitGroupTest.php @@ -0,0 +1,55 @@ +add(2); + $result = []; + $i = 2; + while ($i--) { + Coroutine::create(function () use ($wg, &$result) { + Coroutine::sleep(0.001); + $result[] = true; + $wg->done(); + }); + } + $wg->wait(1); + $this->assertTrue(count($result) === 2); + + $wg->add(); + $wg->add(); + $result = []; + $i = 2; + while ($i--) { + Coroutine::create(function () use ($wg, &$result) { + Coroutine::sleep(0.001); + $result[] = true; + $wg->done(); + }); + } + $wg->wait(1); + $this->assertTrue(count($result) === 2); + } +} diff --git a/src/view/composer.json b/src/view/composer.json index 89d9baca3..0fb793a49 100644 --- a/src/view/composer.json +++ b/src/view/composer.json @@ -26,7 +26,9 @@ "suggest": { "hyperf/task": "Required to use task as a view render mode.", "smarty/smarty": "Required to use smarty as a view render engine.", - "duncan3dc/blade": "Required to use blade as a view render engine." + "twig/twig": "Required to use twig as a view render engine.", + "duncan3dc/blade": "Required to use blade as a view render engine.", + "league/plates": "Required to use plates as a view render engine." }, "autoload": { "psr-4": { @@ -35,6 +37,7 @@ }, "autoload-dev": { "psr-4": { + "HyperfTest\\View\\": "tests/" } }, "config": { diff --git a/src/view/src/Engine/PlatesEngine.php b/src/view/src/Engine/PlatesEngine.php new file mode 100644 index 000000000..bcc8dfc2d --- /dev/null +++ b/src/view/src/Engine/PlatesEngine.php @@ -0,0 +1,25 @@ +render($template, $data); + } +} diff --git a/src/view/src/Engine/TwigEngine.php b/src/view/src/Engine/TwigEngine.php new file mode 100644 index 000000000..f535a8880 --- /dev/null +++ b/src/view/src/Engine/TwigEngine.php @@ -0,0 +1,27 @@ + $config['cache_path']]); + + return $twig->render($template, $data); + } +} diff --git a/src/view/tests/PlatesTest.php b/src/view/tests/PlatesTest.php new file mode 100644 index 000000000..b6a8dc5a9 --- /dev/null +++ b/src/view/tests/PlatesTest.php @@ -0,0 +1,46 @@ + __DIR__ . '/tpl', + 'cache_path' => __DIR__ . '/runtime', + 'file_extension' => 'plates', + ]; + + $engine = new PlatesEngine(); + $res = $engine->render('index', ['name' => 'Hyperf'], $config); + + $this->assertEquals(' + + + +