Could not store token! Make sure that the directory `tokens` exists and is writable!'); +} + +function load_token($name) +{ + if(!file_exists("tokens/$name.token")) return null; + return @unserialize(@file_get_contents("tokens/$name.token")); +} + +function delete_token($name) +{ + @unlink("tokens/$name.token"); +} + + + + + +function enable_implicit_flush() +{ + @apache_setenv('no-gzip', 1); + @ini_set('zlib.output_compression', 0); + @ini_set('implicit_flush', 1); + for ($i = 0; $i < ob_get_level(); $i++) { ob_end_flush(); } + ob_implicit_flush(1); + echo ""; +} \ No newline at end of file diff --git a/DropBoxPhp/test_download_Apps b/DropBoxPhp/test_download_Apps new file mode 100644 index 0000000..d538cda --- /dev/null +++ b/DropBoxPhp/test_download_Apps @@ -0,0 +1 @@ +{"error": "File not found"} \ No newline at end of file diff --git a/DropBoxPhp/tokens/access.token b/DropBoxPhp/tokens/access.token new file mode 100644 index 0000000..42b3ffc --- /dev/null +++ b/DropBoxPhp/tokens/access.token @@ -0,0 +1 @@ +a:2:{s:1:"t";s:16:"2lfmugdr7rp3yp2q";s:1:"s";s:15:"i3nrl13aduhhufw";} \ No newline at end of file diff --git a/MySqlClass.php b/MySqlClass.php new file mode 100644 index 0000000..663a5fc --- /dev/null +++ b/MySqlClass.php @@ -0,0 +1,87 @@ +attiva) { + $this->connessione = mysqli_connect($this->nomehost, $this->nomeuser, $this->password); + if ($this->connessione == FALSE) + die(mysqli_error()); + mysqli_select_db($this->connessione, $this->mydb) or die("Errore nella selezione del database. Verificare i parametri nel file config.inc.php"); + $this->attiva = true; + } + else { + return true; + } + } + + public function executeQuery($queryStr) { + $this->connetti(); + + if (!$res = mysqli_query($this->connessione, $queryStr)) + die(mysqli_error()); + return true; + } + + public function insertRecord($queryStr) { + $this->connetti(); + + if (!$res = mysqli_query($this->connessione, $queryStr)) + die(mysqli_error()); + return mysqli_insert_id($this->connessione); + } + + public function queryToObject($queryStr, $encode = true) { + $this->connetti(); + + $sth = mysqli_query($this->connessione, $queryStr) or die(mysqli_error()); + + if($encode){ + $rows = array(); + while ($r = mysqli_fetch_assoc($sth)) { + array_push($rows, array_map('utf8_encode', $r)); + } + mysqli_free_result($sth); + return $rows; + } + else + { + return mysqli_fetch_array($sth); + } + } + + // funzione per la chiusura della connessione + public function disconnetti() { + if ($this->attiva) { + if (mysqli_close($this->connessione)) { + $this->attiva = false; + return true; + } else { + return false; + } + } + } + + public function __destruct() { + $this->disconnetti(); + } + +} + +?> \ No newline at end of file diff --git a/PHPImageWorkshop/Core/Exception/ImageWorkshopLayerException.php b/PHPImageWorkshop/Core/Exception/ImageWorkshopLayerException.php new file mode 100644 index 0000000..34c1562 --- /dev/null +++ b/PHPImageWorkshop/Core/Exception/ImageWorkshopLayerException.php @@ -0,0 +1,22 @@ +width = imagesx($image); + $this->height = imagesy($image); + $this->image = $image; + $this->layers = $this->layerLevels = $this->layerPositions = array(); + $this->clearStack(); + } + + /** + * Clone method: use it if you want to reuse an existing ImageWorkshop object in another variable + * This is important because img resource var references all the same image in PHP. + * Example: $b = clone $a; (never do $b = $a;) + */ + public function __clone() + { + $this->createNewVarFromBackgroundImage(); + } + + // Superimpose a sublayer + // ========================================================= + + /** + * Add an existing ImageWorkshop sublayer and set it in the stack at a given level + * Return an array containing the generated sublayer id in the stack and its corrected level: + * array("layerLevel" => integer, "id" => integer) + * + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param integer $layerLevel + * @param ImageWorkshop $layer + * @param integer $positionX + * @param integer $positionY + * @param string $position + * + * @return array + */ + public function addLayer($layerLevel, $layer, $positionX = 0, $positionY = 0, $position = 'LT') + { + return $this->indexLayer($layerLevel, $layer, $positionX, $positionY, $position); + } + + /** + * Add an existing ImageWorkshop sublayer and set it in the stack at the highest level + * Return an array containing the generated sublayer id in the stack and the highest level: + * array("layerLevel" => integer, "id" => integer) + * + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param ImageWorkshop $layer + * @param integer $positionX + * @param integer $positionY + * @param string $position + * + * @return array + */ + public function addLayerOnTop($layer, $positionX = 0, $positionY = 0, $position = 'LT') + { + return $this->indexLayer($this->highestLayerLevel + 1, $layer, $positionX, $positionY, $position); + } + + /** + * Add an existing ImageWorkshop sublayer and set it in the stack at level 1 + * Return an array containing the generated sublayer id in the stack and level 1: + * array("layerLevel" => integer, "id" => integer) + * + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param ImageWorkshop $layer + * @param integer $positionX + * @param integer $positionY + * @param string $position + * + * @return array + */ + public function addLayerBelow($layer, $positionX = 0, $positionY = 0, $position = 'LT') + { + return $this->indexLayer(1, $layer, $positionX, $positionY, $position); + } + + // Move a sublayer inside the stack + // ========================================================= + + /** + * Move a sublayer on the top of a group stack + * Return new sublayer level if success or false otherwise + * + * @param integer $layerId + * @return mixed + */ + public function moveTop($layerId) + { + return $this->moveTo($layerId, $this->highestLayerLevel, false); + } + + /** + * Move a sublayer to the level 1 of a group stack + * Return new sublayer level if success or false otherwise + * + * @param integer $layerId + * @param integer $level + * + * @return mixed + */ + public function moveBottom($layerId) + { + return $this->moveTo($layerId, 1, true); + } + + /** + * Move a sublayer to the level $level of a group stack + * Return new sublayer level if success or false if layer isn't found + * + * Set $insertUnderTargetedLayer true if you want to move the sublayer under the other sublayer at the targeted level, + * or false to insert it on the top of the other sublayer at the targeted level + * + * @param integer $layerId + * @param integer $level + * @param boolean $insertUnderTargetedLayer + * + * @return mixed + */ + public function moveTo($layerId, $level, $insertUnderTargetedLayer = true) + { + // if the sublayer exists in stack + if ($this->isLayerInIndex($layerId)) { + + $layerOldLevel = $this->getLayerLevel($layerId); + + if ($level < 1) { + $level = 1; + $insertUnderTargetedLayer = true; + } + + if ($level > $this->highestLayerLevel) { + + $level = $this->highestLayerLevel; + $insertUnderTargetedLayer = false; + } + + // Not the same level than the current level + if ($layerOldLevel != $level) { + + $isUnderAndNewLevelHigher = $isUnderAndNewLevelLower = $isOnTopAndNewLevelHigher = $isOnTopAndNewLevelLower = false; + + if ($insertUnderTargetedLayer) { // Under level + + if ($level > $layerOldLevel) { // new level higher + + $incrementorStartingValue = $layerOldLevel; + $stopLoopWhenSmallerThan = $level; + $isUnderAndNewLevelHigher = true; + + } else { // new level lower + + $incrementorStartingValue = $level; + $stopLoopWhenSmallerThan = $layerOldLevel; + $isUnderAndNewLevelLower = true; + } + + } else { // on the top + + if ($level > $layerOldLevel) { // new level higher + + $incrementorStartingValue = $layerOldLevel; + $stopLoopWhenSmallerThan = $level; + $isOnTopAndNewLevelHigher = true; + + } else { // new level lower + + $incrementorStartingValue = $level; + $stopLoopWhenSmallerThan = $layerOldLevel; + $isOnTopAndNewLevelLower = true; + } + } + + ksort($this->layerLevels); + $layerLevelsTmp = $this->layerLevels; + + if ($isOnTopAndNewLevelLower) { + $level++; + } + + for ($i = $incrementorStartingValue; $i < $stopLoopWhenSmallerThan; $i++) { + + if ($isUnderAndNewLevelHigher || $isOnTopAndNewLevelHigher) { + + $this->layerLevels[$i] = $layerLevelsTmp[$i + 1]; + + } else { + + $this->layerLevels[$i + 1] = $layerLevelsTmp[$i]; + } + } + + unset($layerLevelsTmp); + + if ($isUnderAndNewLevelHigher) { + $level--; + } + + $this->layerLevels[$level] = $layerId; + + return $level; + + } else { + return $level; + } + } + + return false; + } + + /** + * Move up a sublayer in the stack (level +1) + * Return new sublayer level if success, false otherwise + * + * @param integer $layerId + * + * @return mixed + */ + public function moveUp($layerId) + { + if ($this->isLayerInIndex($layerId)) { // if the sublayer exists in the stack + $layerOldLevel = $this->getLayerLevel($layerId); + return $this->moveTo($layerId, $layerOldLevel + 1, false); + } + + return false; + } + + /** + * Move down a sublayer in the stack (level -1) + * Return new sublayer level if success, false otherwise + * + * @param integer $layerId + * + * @return mixed + */ + public function moveDown($layerId) + { + if ($this->isLayerInIndex($layerId)) { // if the sublayer exists in the stack + $layerOldLevel = $this->getLayerLevel($layerId); + return $this->moveTo($layerId, $layerOldLevel - 1, true); + } + + return false; + } + + // Merge layers + // ========================================================= + + /** + * Merge a sublayer with another sublayer below it in the stack + * Note: the result layer will conserve the given id + * Return true if success or false if layer isn't found or doesn't have a layer under it in the stack + * + * @param integer $layerId + * + * @return boolean + */ + public function mergeDown($layerId) + { + // if the layer exists in document + if ($this->isLayerInIndex($layerId)) { + + $layerLevel = $this->getLayerLevel($layerId); + $layerPositions = $this->getLayerPositions($layerId); + $layer = $this->getLayer($layerId); + $layerWidth = $layer->getWidth(); + $layerHeight = $layer->getHeight(); + $layerPositionX = $this->layerPositions[$layerId]['x']; + $layerPositionY = $this->layerPositions[$layerId]['y']; + + if ($layerLevel > 1) { + + $underLayerId = $this->layerLevels[$layerLevel - 1]; + $underLayer = $this->getLayer($underLayerId); + $underLayerWidth = $underLayer->getWidth(); + $underLayerHeight = $underLayer->getHeight(); + $underLayerPositionX = $this->layerPositions[$underLayerId]['x']; + $underLayerPositionY = $this->layerPositions[$underLayerId]['y']; + + $totalWidthLayer = $layerWidth + $layerPositionX; + $totalHeightLayer = $layerHeight + $layerPositionY; + + $totalWidthUnderLayer = $underLayerWidth + $underLayerPositionX; + $totalHeightUnderLayer = $underLayerHeight + $underLayerPositionY; + + $minLayerPositionX = $layerPositionX; + + if ($layerPositionX > $underLayerPositionX) { + $minLayerPositionX = $underLayerPositionX; + } + + $minLayerPositionY = $layerPositionY; + + if ($layerPositionY > $underLayerPositionY) { + $minLayerPositionY = $underLayerPositionY; + } + + if ($totalWidthLayer > $totalWidthUnderLayer) { + $layerTmpWidth = $totalWidthLayer - $minLayerPositionX; + } else { + $layerTmpWidth = $totalWidthUnderLayer - $minLayerPositionX; + } + + if ($totalHeightLayer > $totalHeightUnderLayer) { + $layerTmpHeight = $totalHeightLayer - $minLayerPositionY; + } else { + $layerTmpHeight = $totalHeightUnderLayer - $minLayerPositionY; + } + + $layerTmp = ImageWorkshop::initVirginLayer($layerTmpWidth, $layerTmpHeight); + + $layerTmp->addLayer(1, $underLayer, $underLayerPositionX - $minLayerPositionX, $underLayerPositionY - $minLayerPositionY); + $layerTmp->addLayer(2, $layer, $layerPositionX - $minLayerPositionX, $layerPositionY - $minLayerPositionY); + + // Update layers + $layerTmp->mergeAll(); + $this->layers[$underLayerId] = clone $layerTmp; + $this->changePosition($underLayerId, $minLayerPositionX, $minLayerPositionX); + + } else { + + $layerTmp = ImageWorkshop::initFromResourceVar($this->image); + $layerTmp->addLayer(1, $layer, $layerPositionX, $layerPositionY); + + $this->image = $layerTmp->getResult(); // Update background image + } + + unset($layerTmp); + $this->remove($layerId); // Remove the merged layer from the stack + + return true; + } + + return false; + } + + /** + * Merge sublayers in the stack on the layer background + */ + public function mergeAll() + { + $this->image = $this->getResult(); + $this->clearStack(); + } + + /** + * Paste an image on the layer + * You can specify the position left (in pixels) and the position top (in pixels) of the added image relatives to the layer + * Otherwise, it will be set at 0 and 0 + * + * @param string $unit Use one of `UNIT_*` constants, "UNIT_PIXEL" by default + * @param resource $image + * @param integer $positionX + * @param integer $positionY + */ + public function pasteImage($unit = self::UNIT_PIXEL, $image, $positionX = 0, $positionY = 0) + { + if ($unit == self::UNIT_PERCENT) { + + $positionX = round(($positionX / 100) * $this->width); + $positionY = round(($positionY / 100) * $this->height); + } + + imagecopy($this->image, $image, $positionX, $positionY, 0, 0, $image->getWidth(), $image->getHeight()); + } + + // Change sublayer positions + // ========================================================= + + /** + * Change the position of a sublayer for new positions + * + * @param integer $layerId + * @param integer $newPosX + * @param integer $newPosY + * + * @return boolean + */ + public function changePosition($layerId, $newPosX = null, $newPosY = null) + { + // if the sublayer exists in the stack + if ($this->isLayerInIndex($layerId)) { + + if ($newPosX !== null) { + $this->layerPositions[$layerId]['x'] = $newPosX; + } + + if ($newPosY !== null) { + $this->layerPositions[$layerId]['y'] = $newPosY; + } + + return true; + } + + return false; + } + + /** + * Apply a translation on a sublayer that change its positions + * + * @param integer $layerId + * @param integer $addedPosX + * @param integer $addedPosY + * + * @return mixed (array of new positions or false if fail) + */ + public function applyTranslation($layerId, $addedPosX = null, $addedPosY = null) + { + // if the sublayer exists in the stack + if ($this->isLayerInIndex($layerId)) { + + if ($addedPosX !== null) { + $this->layerPositions[$layerId]['x'] += $addedPosX; + } + + if ($addedPosY !== null) { + $this->layerPositions[$layerId]['y'] += $addedPosY; + } + + return $this->layerPositions[$layerId]; + } + + return false; + } + + // Removing sublayers + // ========================================================= + + /** + * Delete a layer (return true if success, false if no sublayer is found) + * + * @param integer $layerId + * + * @return boolean + */ + public function remove($layerId) + { + // if the layer exists in document + if ($this->isLayerInIndex($layerId)) { + + $layerToDeleteLevel = $this->getLayerLevel($layerId); + + // delete + $this->layers[$layerId]->delete(); + unset($this->layers[$layerId]); + unset($this->layerLevels[$layerToDeleteLevel]); + unset($this->layerPositions[$layerId]); + + // One or plural layers are sub of the deleted layer + if (array_key_exists(($layerToDeleteLevel + 1), $this->layerLevels)) { + + ksort($this->layerLevels); + + $layerLevelsTmp = $this->layerLevels; + + $maxOldestLevel = 1; + foreach ($layerLevelsTmp as $levelTmp => $layerIdTmp) { + + if ($levelTmp > $layerToDeleteLevel) { + $this->layerLevels[($levelTmp - 1)] = $layerIdTmp; + } + + $maxOldestLevel++; + } + unset($layerLevelsTmp); + unset($this->layerLevels[$maxOldestLevel]); + } + + $this->highestLayerLevel--; + + return true; + } + + return false; + } + + /** + * Reset the layer stack + * + * @boolean $deleteSubImgVar Delete sublayers image resource var + */ + public function clearStack($deleteSubImgVar = true) + { + if ($deleteSubImgVar) { + foreach ($this->layers as $layer) { + $layer->delete(); + } + } + + unset($this->layers); + unset($this->layerLevels); + unset($this->layerPositions); + + $this->lastLayerId = 0; + $this->layers = array(); + $this->layerLevels = array(); + $this->layerPositions = array(); + $this->highestLayerLevel = 0; + } + + // Perform an action + // ========================================================= + + /** + * Resize the layer by specifying pixel + * + * @param integer $newWidth + * @param integer $newHeight + * @param boolean $converseProportion + * @param integer $positionX + * @param integer $positionY + * @param string $position + * + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * $positionX, $positionY, $position can be ignored unless you choose a new width AND a new height AND to conserve proportion. + */ + public function resizeInPixel($newWidth = null, $newHeight = null, $converseProportion = false, $positionX = 0, $positionY = 0, $position = 'MM') + { + $this->resize(self::UNIT_PIXEL, $newWidth, $newHeight, $converseProportion, $positionX, $positionY, $position); + } + + /** + * Resize the layer by specifying a percent + * + * @param float $percentWidth + * @param float $percentHeight + * @param boolean $converseProportion + * @param integer $positionX + * @param integer $positionY + * @param string $position + * + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * $positionX, $positionY, $position can be ignored unless you choose a new width AND a new height AND to conserve proportion. + */ + public function resizeInPercent($percentWidth = null, $percentHeight = null, $converseProportion = false, $positionX = 0, $positionY = 0, $position = 'MM') + { + $this->resize(self::UNIT_PERCENT, $percentWidth, $percentHeight, $converseProportion, $positionX, $positionY, $position); + } + + /** + * Resize the layer to fit a bounding box by specifying pixel + * + * @param integer $width + * @param integer $height + * @param boolean $converseProportion + */ + public function resizeToFit($width, $height, $converseProportion = false) + { + if ($this->getWidth() <= $width && $this->getHeight() <= $height) { + return; + } + + if (!$converseProportion) { + $width = min($width, $this->getWidth()); + $height = min($height, $this->getHeight()); + } + + $this->resize(self::UNIT_PIXEL, $width, $height, $converseProportion ? 2 : false); + } + + /** + * Resize the layer + * + * @param string $unit Use one of `UNIT_*` constants, "UNIT_PIXEL" by default + * @param mixed $newWidth (integer or float) + * @param mixed $newHeight (integer or float) + * @param boolean $converseProportion + * @param mixed $positionX (integer or float) + * @param mixed $positionY (integer or float) + * @param string $position + * + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * $positionX, $positionY, $position can be ignored unless you choose a new width AND a new height AND to conserve proportion. + */ + public function resize($unit = self::UNIT_PIXEL, $newWidth = null, $newHeight = null, $converseProportion = false, $positionX = 0, $positionY = 0, $position = 'MM') + { + if (is_numeric($newWidth) || is_numeric($newHeight)) { + + if ($unit == self::UNIT_PERCENT) { + + if ($newWidth) { + $newWidth = round(($newWidth / 100) * $this->width); + } + + if ($newHeight) { + $newHeight = round(($newHeight / 100) * $this->height); + } + } + + if (is_numeric($newWidth) && $newWidth <= 0) { + $newWidth = 1; + } + + if (is_numeric($newHeight) && $newHeight <= 0) { + $newHeight = 1; + } + + if ($converseProportion) { // Proportion are conserved + + if ($newWidth && $newHeight) { // Proportions + $newWidth + $newHeight + + if ($this->getWidth() > $this->getHeight()) { + + $this->resizeInPixel($newWidth, null, true); + + if ($this->getHeight() > $newHeight) { + $this->resizeInPixel(null, $newHeight, true); + } + + } else { + + $this->resizeInPixel(null, $newHeight, true); + + if ($this->getWidth() > $newWidth) { + $this->resizeInPixel($newWidth, null, true); + } + } + + if ($converseProportion !== 2 && ($this->getWidth() != $newWidth || $this->getHeight() != $newHeight)) { + + $layerTmp = ImageWorkshop::initVirginLayer($newWidth, $newHeight); + + $layerTmp->addLayer(1, $this, $positionX, $positionY, $position); + + // Reset part of stack + + unset($this->image); + unset($this->layerLevels); + unset($this->layerPositions); + unset($this->layers); + + // Update current object + + $this->width = $layerTmp->getWidth(); + $this->height = $layerTmp->getHeight(); + $this->layerLevels = $layerTmp->layers[1]->getLayerLevels(); + $this->layerPositions = $layerTmp->layers[1]->getLayerPositions(); + $this->layers = $layerTmp->layers[1]->getLayers(); + $this->lastLayerId = $layerTmp->layers[1]->getLastLayerId(); + $this->highestLayerLevel = $layerTmp->layers[1]->getHighestLayerLevel(); + + $translations = $layerTmp->getLayerPositions(1); + + foreach ($this->layers as $id => $layer) { + $this->applyTranslation($id, $translations['x'], $translations['y']); + } + + $layerTmp->layers[1]->clearStack(false); + $this->image = $layerTmp->getResult(); + unset($layerTmp); + } + + return; + + } elseif ($newWidth) { + + $widthResizePercent = $newWidth / ($this->width / 100); + $newHeight = round(($widthResizePercent / 100) * $this->height); + $heightResizePercent = $widthResizePercent; + + } elseif ($newHeight) { + + $heightResizePercent = $newHeight / ($this->height / 100); + $newWidth = round(($heightResizePercent / 100) * $this->width); + $widthResizePercent = $heightResizePercent; + } + + } elseif (($newWidth && !$newHeight) || (!$newWidth && $newHeight)) { // New width OR new height is given + + if ($newWidth) { + + $widthResizePercent = $newWidth / ($this->width / 100); + $heightResizePercent = 100; + $newHeight = $this->height; + + } else { + + $heightResizePercent = $newHeight / ($this->height / 100); + $widthResizePercent = 100; + $newWidth = $this->width; + } + + } else { // New width AND new height are given + + $widthResizePercent = $newWidth / ($this->width / 100); + $heightResizePercent = $newHeight / ($this->height / 100); + } + + // Update the layer positions in the stack + + foreach ($this->layerPositions as $layerId => $layerPosition) { + + $newPosX = round(($widthResizePercent / 100) * $layerPosition['x']); + $newPosY = round(($heightResizePercent / 100) * $layerPosition['y']); + + $this->changePosition($layerId, $newPosX, $newPosY); + } + + // Resize layers in the stack + + $layers = $this->layers; + + foreach ($layers as $key => $layer) { + $layer->resizeInPercent($widthResizePercent, $heightResizePercent); + $this->layers[$key] = $layer; + } + + $this->resizeBackground($newWidth, $newHeight); // Resize the layer + } + } + + /** + * Resize the layer by its largest side by specifying pixel + * + * @param integer $newLargestSideWidth + * @param boolean $converseProportion + */ + public function resizeByLargestSideInPixel($newLargestSideWidth, $converseProportion = false) + { + $this->resizeByLargestSide(self::UNIT_PIXEL, $newLargestSideWidth, $converseProportion); + } + + /** + * Resize the layer by its largest side by specifying percent + * + * @param integer $newLargestSideWidth percent + * @param boolean $converseProportion + */ + public function resizeByLargestSideInPercent($newLargestSideWidth, $converseProportion = false) + { + $this->resizeByLargestSide(self::UNIT_PERCENT, $newLargestSideWidth, $converseProportion); + } + + /** + * Resize the layer by its largest side + * + * @param string $unit + * @param integer $newLargestSideWidth percent + * @param boolean $converseProportion + */ + public function resizeByLargestSide($unit = self::UNIT_PIXEL, $newLargestSideWidth, $converseProportion = false) + { + if ($unit == self::UNIT_PERCENT) { + $newLargestSideWidth = round(($newLargestSideWidth / 100) * $this->getLargestSideWidth()); + } + + if ($this->getWidth() > $this->getHeight()) { + $this->resizeInPixel($newLargestSideWidth, null, $converseProportion); + } else { + $this->resizeInPixel(null, $newLargestSideWidth, $converseProportion); + } + } + + /** + * Resize the layer by its narrow side by specifying pixel + * + * @param integer $newNarrowSideWidth + * @param boolean $converseProportion + */ + public function resizeByNarrowSideInPixel($newNarrowSideWidth, $converseProportion = false) + { + $this->resizeByNarrowSide(self::UNIT_PIXEL, $newNarrowSideWidth, $converseProportion); + } + + /** + * Resize the layer by its narrow side by specifying percent + * + * @param integer $newNarrowSideWidth percent + * @param boolean $converseProportion + */ + public function resizeByNarrowSideInPercent($newNarrowSideWidth, $converseProportion = false) + { + $this->resizeByNarrowSide(self::UNIT_PERCENT, $newNarrowSideWidth, $converseProportion); + } + + /** + * Resize the layer by its narrow side + * + * @param string $unit + * @param integer $newNarrowSideWidth + * @param boolean $converseProportion + */ + public function resizeByNarrowSide($unit = self::UNIT_PIXEL, $newNarrowSideWidth, $converseProportion = false) + { + if ($unit == self::UNIT_PERCENT) { + $newNarrowSideWidth = round(($newNarrowSideWidth / 100) * $this->getNarrowSideWidth()); + } + + if ($this->getWidth() < $this->getHeight()) { + $this->resizeInPixel($newNarrowSideWidth, null, $converseProportion); + } else { + $this->resizeInPixel(null, $newNarrowSideWidth, $converseProportion); + } + } + + /** + * Crop the document by specifying pixels + * + * $backgroundColor: can be set transparent (The script will be longer to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param integer $width + * @param integer $height + * @param integer $positionX + * @param integer $positionY + * @param string $position + */ + public function cropInPixel($width = 0, $height = 0, $positionX = 0, $positionY = 0, $position = 'LT') + { + $this->crop(self::UNIT_PIXEL, $width, $height, $positionX, $positionY, $position); + } + + /** + * Crop the document by specifying percent + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param float $percentWidth + * @param float $percentHeight + * @param float $positionXPercent + * @param float $positionYPercent + * @param string $position + */ + public function cropInPercent($percentWidth = 0, $percentHeight = 0, $positionXPercent = 0, $positionYPercent = 0, $position = 'LT') + { + $this->crop(self::UNIT_PERCENT, $percentWidth, $percentHeight, $positionXPercent, $positionYPercent, $position); + } + + /** + * Crop the document + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param string $unit + * @param mixed $width (integer or float) + * @param mixed $height (integer or float) + * @param mixed $positionX (integer or float) + * @param mixed $positionY (integer or float) + * @param string $position + */ + public function crop($unit = self::UNIT_PIXEL, $width = 0, $height = 0, $positionX = 0, $positionY = 0, $position = 'LT') + { + if ($width < 0 || $height < 0) { + throw new ImageWorkshopLayerException('You can\'t use negative $width or $height for "'.__METHOD__.'" method.', static::ERROR_NEGATIVE_NUMBER_USED); + } + + if ($unit == self::UNIT_PERCENT) { + + $width = round(($width / 100) * $this->width); + $height = round(($height / 100) * $this->height); + + $positionX = round(($positionX / 100) * $this->width); + $positionY = round(($positionY / 100) * $this->height); + } + + if (($width != $this->width || $positionX == 0) || ($height != $this->height || $positionY == 0)) { + + if ($width == 0) { + $width = 1; + } + + if ($height == 0) { + $height = 1; + } + + $layerTmp = ImageWorkshop::initVirginLayer($width, $height); + $layerClone = ImageWorkshop::initVirginLayer($this->width, $this->height); + + imagedestroy($layerClone->image); + $layerClone->image = $this->image; + + $layerTmp->addLayer(1, $layerClone, -$positionX, -$positionY, $position); + + $newPos = $layerTmp->getLayerPositions(); + $layerNewPosX = $newPos[1]['x']; + $layerNewPosY = $newPos[1]['y']; + + // update the layer + $this->width = $layerTmp->getWidth(); + $this->height = $layerTmp->getHeight(); + $this->image = $layerTmp->getResult(); + unset($layerTmp); + unset($layerClone); + + $this->updateLayerPositionsAfterCropping($layerNewPosX, $layerNewPosY); + } + } + + /** + * Crop the document to a specific aspect ratio by specifying a shift in pixel + * + * $backgroundColor: can be set transparent (The script will be longer to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param integer $width + * @param integer $height + * @param integer $positionX + * @param integer $positionY + * @param string $position + */ + public function cropToAspectRatioInPixel($width = 0, $height = 0, $positionX = 0, $positionY = 0, $position = 'LT') + { + $this->cropToAspectRatio(self::UNIT_PIXEL, $width, $height, $positionX, $positionY, $position); + } + + /** + * Crop the document to a specific aspect ratio by specifying a shift in percent + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param integer $width + * @param integer $height + * @param float $positionXPercent + * @param float $positionYPercent + * @param string $position + */ + public function cropToAspectRatioInPercent($width = 0, $height = 0, $positionXPercent = 0, $positionYPercent = 0, $position = 'LT') + { + $this->cropToAspectRatio(self::UNIT_PERCENT, $width, $height, $positionXPercent, $positionYPercent, $position); + } + + /** + * Crop the document to a specific aspect ratio + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param string $unit + * @param integer $width (integer or float) + * @param integer $height (integer or float) + * @param mixed $positionX (integer or float) + * @param mixed $positionY (integer or float) + * @param string $position + */ + public function cropToAspectRatio($unit = self::UNIT_PIXEL, $width = 0, $height = 0, $positionX = 0, $positionY = 0, $position = 'LT') + { + if ($width < 0 || $height < 0) { + throw new ImageWorkshopLayerException('You can\'t use negative $width or $height for "'.__METHOD__.'" method.', static::ERROR_NEGATIVE_NUMBER_USED); + } + + if ($width == 0) { + $width = 1; + } + + if ($height == 0) { + $height = 1; + } + + if ($this->width / $this->height <= $width / $height) { + $newWidth = $this->width; + $newHeight = round($height * ($this->width / $width)); + } else { + $newWidth = round($width * ($this->height / $height)); + $newHeight = $this->height; + } + + if ($unit == self::UNIT_PERCENT) { + $positionX = round(($positionX / 100) * ($this->width - $newWidth)); + $positionY = round(($positionY / 100) * ($this->height - $newHeight)); + } + + $this->cropInPixel($newWidth, $newHeight, $positionX, $positionY, $position); + } + + /** + * Crop the maximum possible from left top ("LT"), "RT"... by specifying a shift in pixel + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param integer $width + * @param integer $height + * @param integer $positionX + * @param integer $positionY + * @param string $position + */ + public function cropMaximumInPixel($positionX = 0, $positionY = 0, $position = 'LT') + { + $this->cropMaximum(self::UNIT_PIXEL, $positionX, $positionY, $position); + } + + /** + * Crop the maximum possible from left top ("LT"), "RT"... by specifying a shift in percent + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param integer $width + * @param integer $height + * @param integer $positionXPercent + * @param integer $positionYPercent + * @param string $position + */ + public function cropMaximumInPercent($positionXPercent = 0, $positionYPercent = 0, $position = 'LT') + { + $this->cropMaximum(self::UNIT_PERCENT, $positionXPercent, $positionYPercent, $position); + } + + /** + * Crop the maximum possible from left top + * + * $backgroundColor can be set transparent (but script could be long to execute) + * $position: http://phpimageworkshop.com/doc/22/corners-positions-schema-of-an-image.html + * + * @param string $unit + * @param integer $width + * @param integer $height + * @param integer $positionX + * @param integer $positionY + * @param string $position + */ + public function cropMaximum($unit = self::UNIT_PIXEL, $positionX = 0, $positionY = 0, $position = 'LT') + { + $narrowSide = $this->getNarrowSideWidth(); + + if ($unit == self::UNIT_PERCENT) { + $positionX = round(($positionX / 100) * $this->width); + $positionY = round(($positionY / 100) * $this->height); + } + + $this->cropInPixel($narrowSide, $narrowSide, $positionX, $positionY, $position); + } + + /** + * Rotate the layer (in degree) + * + * @param float $degrees + */ + public function rotate($degrees) + { + if ($degrees != 0) { + + if ($degrees < -360 || $degrees > 360) { + $degrees = $degrees % 360; + } + + if ($degrees < 0 && $degrees >= -360) { + $degrees = 360 + $degrees; + } + + // Rotate the layer background image + $imageRotated = imagerotate($this->image, -$degrees, -1); + imagealphablending($imageRotated, true); + imagesavealpha($imageRotated, true); + + unset($this->image); + + $this->image = $imageRotated; + + $oldWidth = $this->width; + $oldHeight = $this->height; + + $this->width = imagesx($this->image); + $this->height = imagesy($this->image); + + foreach ($this->layers as $layerId => $layer) { + + $layerSelfOldCenterPosition = array( + 'x' => $layer->width / 2, + 'y' => $layer->height / 2, + ); + + $smallImageCenter = array( + 'x' => $layerSelfOldCenterPosition['x'] + $this->layerPositions[$layerId]['x'], + 'y' => $layerSelfOldCenterPosition['y'] + $this->layerPositions[$layerId]['y'], + ); + + $this->layers[$layerId]->rotate($degrees); + + $ro = sqrt(pow($smallImageCenter['x'], 2) + pow($smallImageCenter['y'], 2)); + + $teta = (acos($smallImageCenter['x'] / $ro)) * 180 / pi(); + + $a = $ro * cos(($teta + $degrees) * pi() / 180); + $b = $ro * sin(($teta + $degrees) * pi() / 180); + + if ($degrees > 0 && $degrees <= 90) { + + $newPositionX = $a - ($this->layers[$layerId]->width / 2) + $oldHeight * sin(($degrees * pi()) / 180); + $newPositionY = $b - ($this->layers[$layerId]->height / 2); + + } elseif ($degrees > 90 && $degrees <= 180) { + + $newPositionX = $a - ($this->layers[$layerId]->width / 2) + $this->width; + $newPositionY = $b - ($this->layers[$layerId]->height / 2) + $oldHeight * (-cos(($degrees) * pi() / 180)); + + } elseif ($degrees > 180 && $degrees <= 270) { + + $newPositionX = $a - ($this->layers[$layerId]->width / 2) + $oldWidth * (-cos(($degrees) * pi() / 180)); + $newPositionY = $b - ($this->layers[$layerId]->height / 2) + $this->height; + + } else { + + $newPositionX = $a - ($this->layers[$layerId]->width / 2); + $newPositionY = $b - ($this->layers[$layerId]->height / 2) + $oldWidth * (-sin(($degrees) * pi() / 180)); + } + + $this->layerPositions[$layerId] = array( + 'x' => $newPositionX, + 'y' => $newPositionY, + ); + } + } + } + + /** + * Change the opacity of the layer + * $recursive: apply it on sublayers + * + * @param integer $opacity + * @param boolean $recursive + */ + public function opacity($opacity, $recursive = true) + { + if ($recursive) { + + $layers = $this->layers; + + foreach ($layers as $key => $layer) { + $layer->opacity($opacity, true); + $this->layers[$key] = $layer; + } + } + + $transparentImage = ImageWorkshopLib::generateImage($this->getWidth(), $this->getHeight()); + + ImageWorkshopLib::imageCopyMergeAlpha($transparentImage, $this->image, 0, 0, 0, 0, $this->getWidth(), $this->getHeight(), $opacity); + + unset($this->image); + $this->image = $transparentImage; + unset($transparentImage); + } + + /** + * Apply a filter on the layer + * Be careful: some filters can damage transparent images, use it sparingly ! (A good pratice is to use mergeAll on your layer before applying a filter) + * + * @param int $filterType (http://www.php.net/manual/en/function.imagefilter.php) + * @param int $arg1 + * @param int $arg2 + * @param int $arg3 + * @param int $arg4 + * @param boolean $recursive + */ + public function applyFilter($filterType, $arg1 = null, $arg2 = null, $arg3 = null, $arg4 = null, $recursive = false) + { + if ($filterType == IMG_FILTER_COLORIZE) { + imagefilter($this->image, $filterType, $arg1, $arg2, $arg3, $arg4); + } elseif ($filterType == IMG_FILTER_BRIGHTNESS || $filterType == IMG_FILTER_CONTRAST || $filterType == IMG_FILTER_SMOOTH) { + imagefilter($this->image, $filterType, $arg1); + } elseif ($filterType == IMG_FILTER_PIXELATE) { + imagefilter($this->image, $filterType, $arg1, $arg2); + } else { + imagefilter($this->image, $filterType); + } + + if ($recursive) { + + $layers = $this->layers; + + foreach($layers as $layerId => $layer) { + $this->layers[$layerId]->applyFilter($filterType, $arg1, $arg2, $arg3, $arg4, true); + } + } + } + + /** + * Apply horizontal or vertical flip (Transformation) + * + * @param string $type + */ + public function flip($type = 'horizontal') + { + $layers = $this->layers; + + foreach ($layers as $key => $layer) { + + $layer->flip($type); + $this->layers[$key] = $layer; + } + + $temp = ImageWorkshopLib::generateImage($this->width, $this->height); + + if ($type == 'horizontal') { + + imagecopyresampled($temp, $this->image, 0, 0, $this->width - 1, 0, $this->width, $this->height, -$this->width, $this->height); + $this->image = $temp; + + foreach ($this->layerPositions as $layerId => $layerPositions) { + + $this->changePosition($layerId, $this->width - $this->layers[$layerId]->getWidth() - $layerPositions['x'], $layerPositions['y']); + } + + } elseif ($type == 'vertical') { + + imagecopyresampled($temp, $this->image, 0, 0, 0, $this->height - 1, $this->width, $this->height, $this->width, -$this->height); + $this->image = $temp; + + foreach ($this->layerPositions as $layerId => $layerPositions) { + + $this->changePosition($layerId, $layerPositions['x'], $this->height - $this->layers[$layerId]->getHeight() - $layerPositions['y']); + } + } + + unset($temp); + } + + /** + * Add a text on the background image of the layer using a default font registered in GD + * + * @param string $text + * @param integer $font + * @param string $color + * @param integer $positionX + * @param integer $positionY + * @param string $align + */ + public function writeText($text, $font = 1, $color = 'ffffff', $positionX = 0, $positionY = 0, $align = 'horizontal') + { + $RGBTextColor = ImageWorkshopLib::convertHexToRGB($color); + $textColor = imagecolorallocate($this->image, $RGBTextColor['R'], $RGBTextColor['G'], $RGBTextColor['B']); + + if ($align == 'horizontal') { + imagestring($this->image, $font, $positionX, $positionY, $text, $textColor); + } else { + imagestringup($this->image, $font, $positionX, $positionY, $text, $textColor); + } + } + + /** + * Add a text on the background image of the layer using a font localized at $fontPath + * Return the text coordonates + * + * @param string $text + * @param integer $fontPath + * @param integer $fontSize + * @param string $color + * @param integer $positionX + * @param integer $positionY + * @param integer $fontRotation + * + * @return array + */ + public function write($text, $fontPath, $fontSize = 13, $color = 'ffffff', $positionX = 0, $positionY = 0, $fontRotation = 0) + { + if (!file_exists($fontPath)) { + throw new ImageWorkshopLayerException('Can\'t find a font file at this path : "'.$fontPath.'".', static::ERROR_FONT_NOT_FOUND); + } + + $RGBTextColor = ImageWorkshopLib::convertHexToRGB($color); + $textColor = imagecolorallocate($this->image, $RGBTextColor['R'], $RGBTextColor['G'], $RGBTextColor['B']); + + return imagettftext($this->image, $fontSize, $fontRotation, $positionX, $positionY, $textColor, $fontPath, $text); + } + + // Manage the result + // ========================================================= + + /** + * Return a merged resource image + * + * $backgroundColor is really usefull if you want to save a JPG or GIF, because the transparency of the background + * would be remove for a colored background, so you should choose a color like "ffffff" (white) + * + * @param string $backgroundColor + * + * @return resource + */ + public function getResult($backgroundColor = null) + { + $imagesToMerge = array(); + ksort($this->layerLevels); + + foreach ($this->layerLevels as $layerLevel => $layerId) { + + $imagesToMerge[$layerLevel] = $this->layers[$layerId]->getResult(); + + // Layer positions + if ($this->layerPositions[$layerId]['x'] != 0 || $this->layerPositions[$layerId]['y'] != 0) { + + $virginLayoutImageTmp = ImageWorkshopLib::generateImage($this->width, $this->height); + ImageWorkshopLib::mergeTwoImages($virginLayoutImageTmp, $imagesToMerge[$layerLevel], $this->layerPositions[$layerId]['x'], $this->layerPositions[$layerId]['y'], 0, 0); + $imagesToMerge[$layerLevel] = $virginLayoutImageTmp; + unset($virginLayoutImageTmp); + } + } + + $iterator = 1; + $mergedImage = $this->image; + ksort($imagesToMerge); + + foreach ($imagesToMerge as $imageLevel => $image) { + ImageWorkshopLib::mergeTwoImages($mergedImage, $image); + $iterator++; + } + + $opacity = 127; + + if ($backgroundColor && $backgroundColor != 'transparent') { + $opacity = 0; + } + + $backgroundImage = ImageWorkshopLib::generateImage($this->width, $this->height, $backgroundColor, $opacity); + ImageWorkshopLib::mergeTwoImages($backgroundImage, $mergedImage); + $mergedImage = $backgroundImage; + unset($backgroundImage); + + return $mergedImage; + } + + /** + * Save the resulting image at the specified path + * + * $backgroundColor is really usefull if you want to save a JPG or GIF, because the transparency of the background + * would be remove for a colored background, so you should choose a color like "ffffff" (white) + * + * If the file already exists, it will be override ! + * + * $imageQuality is useless for GIF + * + * Ex: $folder = __DIR__."/../web/images/2012" + * $imageName = "butterfly.jpg" + * $createFolders = true + * $imageQuality = 95 + * $backgroundColor = "ffffff" + * + * @param string $folder + * @param string $imageName + * @param boolean $createFolders + * @param string $backgroundColor + * @param integer $imageQuality + * @param boolean $interlace + */ + public function save($folder, $imageName, $createFolders = true, $backgroundColor = null, $imageQuality = 75, $interlace = false) + { + if (!is_file($folder)) { + + if (is_dir($folder) || $createFolders) { + + // Creating the folders if they don't exist + if (!is_dir($folder) && $createFolders) { + $oldUmask = umask(0); + mkdir($folder, 0777, true); + umask($oldUmask); + chmod($folder, 0777); + } + + $extension = explode('.', $imageName); + $extension = strtolower($extension[count($extension) - 1]); + + $filename = $folder.'/'.$imageName; + + if (($extension == 'jpg' || $extension == 'jpeg' || $extension == 'gif') && (!$backgroundColor || $backgroundColor == 'transparent')) { + $backgroundColor = 'ffffff'; + } + + $image = $this->getResult($backgroundColor); + + imageinterlace($image, (int) $interlace); + + if ($extension == 'jpg' || $extension == 'jpeg') { + + imagejpeg($image, $filename, $imageQuality); + unset($image); + + } elseif ($extension == 'gif') { + + imagegif($image, $filename); + unset($image); + + } elseif ($extension == 'png') { + + $imageQuality = $imageQuality / 10; + $imageQuality -= 1; + + imagepng($image, $filename, $imageQuality); + unset($image); + } + } + } + } + + // Checkers + // ========================================================= + + /** + * Check if a sublayer exists in the stack for a given id + * + * @param integer $layerId + * + * @return boolean + */ + public function isLayerInIndex($layerId) + { + if (array_key_exists($layerId, $this->layers)) { + return true; + } + + return false; + } + + // Getter / Setter + // ========================================================= + + /** + * Return the narrow side width of the layer + * + * @return integer + */ + public function getNarrowSideWidth() + { + $narrowSideWidth = $this->getWidth(); + + if ($this->getHeight() < $narrowSideWidth) { + $narrowSideWidth = $this->getHeight(); + } + + return $narrowSideWidth; + } + + /** + * Return the largest side width of the layer + * + * @return integer + */ + public function getLargestSideWidth() + { + $largestSideWidth = $this->getWidth(); + + if ($this->getHeight() > $largestSideWidth) { + $largestSideWidth = $this->getHeight(); + } + + return $largestSideWidth; + } + + /** + * Get the level of a sublayer + * Return sublayer level if success or false if layer isn't found + * + * @param integer $layerId + * + * @return mixed (integer or boolean) + */ + public function getLayerLevel($layerId) + { + if ($this->isLayerInIndex($layerId)) { // if the layer exists in document + return array_search($layerId, $this->layerLevels); + } + + return false; + } + + /** + * Get a sublayer in the stack + * Don't forget to use clone method: $b = clone $a->getLayer(3); + * + * @param integer $layerId + * + * @return ImageWorkshop + */ + public function getLayer($layerId) + { + return $this->layers[$layerId]; + } + + /** + * Getter width + * + * @return integer + */ + public function getWidth() + { + return $this->width; + } + + /** + * Getter height + * + * @return integer + */ + public function getHeight() + { + return $this->height; + } + + /** + * Getter image + * + * @return resource + */ + public function getImage() + { + return $this->image; + } + + /** + * Getter layers + * + * @return array + */ + public function getLayers() + { + return $this->layers; + } + + /** + * Getter layerLevels + * + * @return array + */ + public function getLayerLevels() + { + return $this->layerLevels; + } + + /** + * Getter layerPositions + * + * Get all the positions of the sublayers, + * or when specifying $layerId, get the position of this sublayer + * + * @param integer $layerId + * + * @return mixed (array or boolean) + */ + public function getLayerPositions($layerId = null) + { + if (!$layerId) { + + return $this->layerPositions; + + } elseif ($this->isLayerInIndex($layerId)) { // if the sublayer exists in the stack + + return $this->layerPositions[$layerId]; + } + + return false; + } + + /** + * Getter highestLayerLevel + * + * @return array + */ + public function getHighestLayerLevel() + { + return $this->highestLayerLevel; + } + + /** + * Getter lastLayerId + * + * @return array + */ + public function getLastLayerId() + { + return $this->lastLayerId; + } + + // Internals + // ========================================================= + + /** + * Delete the current object + */ + public function delete() + { + imagedestroy($this->image); + $this->clearStack(); + } + + /** + * Create a new background image var from the old background image var + */ + public function createNewVarFromBackgroundImage() + { + $virginImage = ImageWorkshopLib::generateImage($this->getWidth(), $this->getHeight()); // New background image + + ImageWorkshopLib::mergeTwoImages($virginImage, $this->image, 0, 0, 0, 0); + unset($this->image); + + $this->image = $virginImage; + unset($virginImage); + + $layers = $this->layers; + + foreach($layers as $layerId => $layer) { + $this->layers[$layerId] = clone $this->layers[$layerId]; + } + } + + /** + * Index a sublayer in the layer stack + * Return an array containing the generated sublayer id and its final level: + * array("layerLevel" => integer, "id" => integer) + * + * @param integer $layerLevel + * @param ImageWorkshopLayer $layer + * @param integer $positionX + * @param integer $positionY + * @param string $position + * + * @return array + */ + protected function indexLayer($layerLevel, $layer, $positionX = 0, $positionY = 0, $position) + { + // Choose an id for the added layer + $layerId = $this->lastLayerId + 1; + + // Clone $layer to duplicate image resource var + $layer = clone $layer; + + // Add the layer in the stack + $this->layers[$layerId] = $layer; + + // Add the layer positions in the main layer + $this->layerPositions[$layerId] = ImageWorkshopLib::calculatePositions($this->getWidth(), $this->getHeight(), $layer->getWidth(), $layer->getHeight(), $positionX, $positionY, $position); + + // Update the lastLayerId of the workshop + $this->lastLayerId = $layerId; + + // Add the layer level in the stack + $layerLevel = $this->indexLevelInDocument($layerLevel, $layerId); + + return array( + 'layerLevel' => $layerLevel, + 'id' => $layerId, + ); + } + + /** + * Index a layer level and update the layers levels in the document + * Return the corrected level of the layer + * + * @param integer $layerLevel + * @param integer $layerId + * + * @return integer + */ + protected function indexLevelInDocument($layerLevel, $layerId) + { + if (array_key_exists($layerLevel, $this->layerLevels)) { // Level already exists + + ksort($this->layerLevels); // All layers after this level and the layer which have this level are updated + $layerLevelsTmp = $this->layerLevels; + + foreach ($layerLevelsTmp as $levelTmp => $layerIdTmp) { + if ($levelTmp >= $layerLevel) { + $this->layerLevels[$levelTmp + 1] = $layerIdTmp; + } + } + + unset($layerLevelsTmp); + + } else { // Level isn't taken + if ($this->highestLayerLevel < $layerLevel) { // If given level is too high, proceed adjustement + $layerLevel = $this->highestLayerLevel + 1; + } + } + + $this->layerLevels[$layerLevel] = $layerId; + $this->highestLayerLevel = max(array_flip($this->layerLevels)); // Update $highestLayerLevel + + return $layerLevel; + } + + /** + * Update the positions of layers in the stack after cropping + * + * @param integer $positionX + * @param integer $positionY + */ + public function updateLayerPositionsAfterCropping($positionX, $positionY) + { + foreach ($this->layers as $layerId => $layer) { + + $oldLayerPosX = $this->layerPositions[$layerId]['x']; + $oldLayerPosY = $this->layerPositions[$layerId]['y']; + + $newLayerPosX = $oldLayerPosX + $positionX; + $newLayerPosY = $oldLayerPosY + $positionY; + + $this->changePosition($layerId, $newLayerPosX, $newLayerPosY); + } + } + + /** + * Resize the background of a layer + * + * @param integer $newWidth + * @param integer $newHeight + */ + public function resizeBackground($newWidth, $newHeight) + { + $oldWidth = $this->width; + $oldHeight = $this->height; + + $this->width = $newWidth; + $this->height = $newHeight; + + $virginLayoutImage = ImageWorkshopLib::generateImage($this->width, $this->height); + + imagecopyresampled($virginLayoutImage, $this->image, 0, 0, 0, 0, $this->width, $this->height, $oldWidth, $oldHeight); + + unset($this->image); + $this->image = $virginLayoutImage; + } + + // Deprecated, don't use anymore + // ========================================================= + + /** + * @deprecated + */ + public function resizeInPourcent($percentWidth = null, $percentHeight = null, $converseProportion = false, $positionX = 0, $positionY = 0, $position = 'MM') + { + throw new ImageWorkshopLayerException('Method resizeInPourcent() was renamed resizeInPercent(). Use resizeInPercent() instead.', static::METHOD_DEPRECATED); + } + + /** + * @deprecated + */ + public function resizeByLargestSideInPourcent($newLargestSideWidth, $converseProportion = false) + { + throw new ImageWorkshopLayerException('Method resizeByLargestSideInPourcent() was renamed resizeByLargestSideInPercent(). Use resizeByLargestSideInPercent() instead.', static::METHOD_DEPRECATED); + } + + /** + * @deprecated + */ + public function resizeByNarrowSideInPourcent($newNarrowSideWidth, $converseProportion = false) + { + throw new ImageWorkshopLayerException('Method resizeByNarrowSideInPourcent() was renamed resizeByNarrowSideInPercent(). Use resizeByNarrowSideInPercent() instead.', static::METHOD_DEPRECATED); + } + + /** + * @deprecated + */ + public function cropInPourcent($percentWidth = 0, $percentHeight = 0, $positionXPercent = 0, $positionYPercent = 0, $position = 'LT') + { + throw new ImageWorkshopLayerException('Method cropInPourcent() was renamed cropInPercent(). Use cropInPercent() instead.', static::METHOD_DEPRECATED); + } + + /** + * @deprecated + */ + public function cropMaximumInPourcent($positionXPercent = 0, $positionYPercent = 0, $position = 'LT') + { + throw new ImageWorkshopLayerException('Method cropMaximumInPourcent() was renamed cropMaximumInPercent(). Use cropMaximumInPercent() instead.', static::METHOD_DEPRECATED); + } +} diff --git a/PHPImageWorkshop/Core/ImageWorkshopLib.php b/PHPImageWorkshop/Core/ImageWorkshopLib.php new file mode 100644 index 0000000..c650218 --- /dev/null +++ b/PHPImageWorkshop/Core/ImageWorkshopLib.php @@ -0,0 +1,299 @@ + $layerPositionX, + 'y' => $layerPositionY, + ); + } + + /** + * Convert Hex color to RGB color format + * + * @param string $hex + * + * @return array + */ + public static function convertHexToRGB($hex) + { + return array( + 'R' => (int) base_convert(substr($hex, 0, 2), 16, 10), + 'G' => (int) base_convert(substr($hex, 2, 2), 16, 10), + 'B' => (int) base_convert(substr($hex, 4, 2), 16, 10), + ); + } + + /** + * Generate a new image resource var + * + * @param integer $width + * @param integer $height + * @param string $color + * @param integer $opacity + * + * @return resource + */ + public static function generateImage($width = 100, $height = 100, $color = 'ffffff', $opacity = 127) + { + $RGBColors = ImageWorkshopLib::convertHexToRGB($color); + + $image = imagecreatetruecolor($width, $height); + imagesavealpha($image, true); + $color = imagecolorallocatealpha($image, $RGBColors['R'], $RGBColors['G'], $RGBColors['B'], $opacity); + imagefill($image, 0, 0, $color); + + return $image; + } + + /** + * Return dimension of a text + * + * @param $fontSize + * @param $fontAngle + * @param $fontFile + * @param $text + * + * @return array or boolean + */ + public static function getTextBoxDimension($fontSize, $fontAngle, $fontFile, $text) + { + if (!file_exists($fontFile)) { + throw new ImageWorkshopLibException('Can\'t find a font file at this path : "'.$fontFile.'".', static::ERROR_FONT_NOT_FOUND); + } + + $box = imagettfbbox($fontSize, $fontAngle, $fontFile, $text); + + if (!$box) { + + return false; + } + + $minX = min(array($box[0], $box[2], $box[4], $box[6])); + $maxX = max(array($box[0], $box[2], $box[4], $box[6])); + $minY = min(array($box[1], $box[3], $box[5], $box[7])); + $maxY = max(array($box[1], $box[3], $box[5], $box[7])); + $width = ($maxX - $minX); + $height = ($maxY - $minY); + $left = abs($minX) + $width; + $top = abs($minY) + $height; + + // to calculate the exact bounding box, we write the text in a large image + $img = @imagecreatetruecolor($width << 2, $height << 2); + $white = imagecolorallocate($img, 255, 255, 255); + $black = imagecolorallocate($img, 0, 0, 0); + imagefilledrectangle($img, 0, 0, imagesx($img), imagesy($img), $black); + + // for ensure that the text is completely in the image + imagettftext($img, $fontSize, $fontAngle, $left, $top, $white, $fontFile, $text); + + // start scanning (0=> black => empty) + $rleft = $w4 = $width<<2; + $rright = 0; + $rbottom = 0; + $rtop = $h4 = $height<<2; + + for ($x = 0; $x < $w4; $x++) { + + for ($y = 0; $y < $h4; $y++) { + + if (imagecolorat($img, $x, $y)) { + + $rleft = min($rleft, $x); + $rright = max($rright, $x); + $rtop = min($rtop, $y); + $rbottom = max($rbottom, $y); + } + } + } + + imagedestroy($img); + + return array( + 'left' => $left - $rleft, + 'top' => $top - $rtop, + 'width' => $rright - $rleft + 1, + 'height' => $rbottom - $rtop + 1, + ); + } + + /** + * Copy an image on another one and converse transparency + * + * @param resource $destImg + * @param resource $srcImg + * @param integer $destX + * @param integer $destY + * @param integer $srcX + * @param integer $srcY + * @param integer $srcW + * @param integer $srcH + * @param integer $pct + */ + public static function imageCopyMergeAlpha(&$destImg, &$srcImg, $destX, $destY, $srcX, $srcY, $srcW, $srcH, $pct = 0) + { + $destX = (int) $destX; + $destY = (int) $destY; + $srcX = (int) $srcX; + $srcY = (int) $srcY; + $srcW = (int) $srcW; + $srcH = (int) $srcH; + $pct = (int) $pct; + $destW = imageSX($destImg); + $destH = imageSY($destImg); + + for ($y = 0; $y < $srcH + $srcY; $y++) { + + for ($x = 0; $x < $srcW + $srcX; $x++) { + + if ($x + $destX >= 0 && $x + $destX < $destW && $x + $srcX >= 0 && $x + $srcX < $srcW && $y + $destY >= 0 && $y + $destY < $destH && $y + $srcY >= 0 && $y + $srcY < $srcH) { + + $destPixel = imageColorsForIndex($destImg, imageColorat($destImg, $x + $destX, $y + $destY)); + $srcImgColorat = imageColorat($srcImg, $x + $srcX, $y + $srcY); + + if ($srcImgColorat >= 0) { + + $srcPixel = imageColorsForIndex($srcImg, $srcImgColorat); + + $srcAlpha = 1 - ($srcPixel['alpha'] / 127); + $destAlpha = 1 - ($destPixel['alpha'] / 127); + $opacity = $srcAlpha * $pct / 100; + + if ($destAlpha >= $opacity) { + $alpha = $destAlpha; + } + + if ($destAlpha < $opacity) { + $alpha = $opacity; + } + + if ($alpha > 1) { + $alpha = 1; + } + + if ($opacity > 0) { + + $destRed = round((($destPixel['red'] * $destAlpha * (1 - $opacity)))); + $destGreen = round((($destPixel['green'] * $destAlpha * (1 - $opacity)))); + $destBlue = round((($destPixel['blue'] * $destAlpha * (1 - $opacity)))); + $srcRed = round((($srcPixel['red'] * $opacity))); + $srcGreen = round((($srcPixel['green'] * $opacity))); + $srcBlue = round((($srcPixel['blue'] * $opacity))); + $red = round(($destRed + $srcRed ) / ($destAlpha * (1 - $opacity) + $opacity)); + $green = round(($destGreen + $srcGreen) / ($destAlpha * (1 - $opacity) + $opacity)); + $blue = round(($destBlue + $srcBlue ) / ($destAlpha * (1 - $opacity) + $opacity)); + + if ($red > 255) { + $red = 255; + } + + if ($green > 255) { + $green = 255; + } + + if ($blue > 255) { + $blue = 255; + } + + $alpha = round((1 - $alpha) * 127); + $color = imageColorAllocateAlpha($destImg, $red, $green, $blue, $alpha); + imageSetPixel($destImg, $x + $destX, $y + $destY, $color); + } + } + } + } + } + } + + /** + * Merge two image var + * + * @param resource $destinationImage + * @param resource $sourceImage + * @param integer $destinationPosX + * @param integer $destinationPosY + * @param integer $sourcePosX + * @param integer $sourcePosY + */ + public static function mergeTwoImages(&$destinationImage, $sourceImage, $destinationPosX = 0, $destinationPosY = 0, $sourcePosX = 0, $sourcePosY = 0) + { + imageCopy($destinationImage, $sourceImage, $destinationPosX, $destinationPosY, $sourcePosX, $sourcePosY, imageSX($sourceImage), imageSY($sourceImage)); + } +} \ No newline at end of file diff --git a/PHPImageWorkshop/Exception/ImageWorkshopBaseException.php b/PHPImageWorkshop/Exception/ImageWorkshopBaseException.php new file mode 100644 index 0000000..e1925f5 --- /dev/null +++ b/PHPImageWorkshop/Exception/ImageWorkshopBaseException.php @@ -0,0 +1,38 @@ +code}]: {$this->message}\n"; + } +} \ No newline at end of file diff --git a/PHPImageWorkshop/Exception/ImageWorkshopException.php b/PHPImageWorkshop/Exception/ImageWorkshopException.php new file mode 100644 index 0000000..7663c93 --- /dev/null +++ b/PHPImageWorkshop/Exception/ImageWorkshopException.php @@ -0,0 +1,22 @@ +write($text, $fontPath, $fontSize, $fontColor, $textDimensions['left'], $textDimensions['top'], $textRotation); + + return $layer; + } + + /** + * Initialize a new virgin layer + * + * @param integer $width + * @param integer $height + * @param string $backgroundColor + * + * @return ImageWorkshopLayer + */ + public static function initVirginLayer($width = 100, $height = 100, $backgroundColor = null) + { + $opacity = 0; + + if (!$backgroundColor || $backgroundColor == 'transparent') { + $opacity = 127; + $backgroundColor = 'ffffff'; + } + + return new ImageWorkshopLayer(ImageWorkshopLib::generateImage($width, $height, $backgroundColor, $opacity)); + } + + /** + * Initialize a layer from a resource image var + * + * @param \resource $image + * + * @return ImageWorkshopLayer + */ + public static function initFromResourceVar($image) + { + return new ImageWorkshopLayer($image); + } + + /** + * Initialize a layer from a string (obtains with file_get_contents, cURL...) + * + * This not recommanded to initialize JPEG string with this method, GD displays bugs ! + * + * @param string $imageString + * + * @return ImageWorkshopLayer + */ + public static function initFromString($imageString) + { + if (!$image = @imageCreateFromString($imageString)) { + throw new ImageWorkshopException('Can\'t generate an image from the given string.', static::ERROR_CREATE_IMAGE_FROM_STRING); + } + + return new ImageWorkshopLayer($image); + } +} \ No newline at end of file diff --git a/Slim/Environment.php b/Slim/Environment.php new file mode 100644 index 0000000..a15e1e4 --- /dev/null +++ b/Slim/Environment.php @@ -0,0 +1,224 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim; + +/** + * Environment + * + * This class creates and returns a key/value array of common + * environment variables for the current HTTP request. + * + * This is a singleton class; derived environment variables will + * be common across multiple Slim applications. + * + * This class matches the Rack (Ruby) specification as closely + * as possible. More information available below. + * + * @package Slim + * @author Josh Lockhart + * @since 1.6.0 + */ +class Environment implements \ArrayAccess, \IteratorAggregate +{ + /** + * @var array + */ + protected $properties; + + /** + * @var \Slim\Environment + */ + protected static $environment; + + /** + * Get environment instance (singleton) + * + * This creates and/or returns an environment instance (singleton) + * derived from $_SERVER variables. You may override the global server + * variables by using `\Slim\Environment::mock()` instead. + * + * @param bool $refresh Refresh properties using global server variables? + * @return \Slim\Environment + */ + public static function getInstance($refresh = false) + { + if (is_null(self::$environment) || $refresh) { + self::$environment = new self(); + } + + return self::$environment; + } + + /** + * Get mock environment instance + * + * @param array $userSettings + * @return \Slim\Environment + */ + public static function mock($userSettings = array()) + { + $defaults = array( + 'REQUEST_METHOD' => 'GET', + 'SCRIPT_NAME' => '', + 'PATH_INFO' => '', + 'QUERY_STRING' => '', + 'SERVER_NAME' => 'localhost', + 'SERVER_PORT' => 80, + 'ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', + 'ACCEPT_LANGUAGE' => 'en-US,en;q=0.8', + 'ACCEPT_CHARSET' => 'ISO-8859-1,utf-8;q=0.7,*;q=0.3', + 'USER_AGENT' => 'Slim Framework', + 'REMOTE_ADDR' => '127.0.0.1', + 'slim.url_scheme' => 'http', + 'slim.input' => '', + 'slim.errors' => @fopen('php://stderr', 'w') + ); + self::$environment = new self(array_merge($defaults, $userSettings)); + + return self::$environment; + } + + /** + * Constructor (private access) + * + * @param array|null $settings If present, these are used instead of global server variables + */ + private function __construct($settings = null) + { + if ($settings) { + $this->properties = $settings; + } else { + $env = array(); + + //The HTTP request method + $env['REQUEST_METHOD'] = $_SERVER['REQUEST_METHOD']; + + //The IP + $env['REMOTE_ADDR'] = $_SERVER['REMOTE_ADDR']; + + // Server params + $scriptName = $_SERVER['SCRIPT_NAME']; // <-- "/foo/index.php" + $requestUri = $_SERVER['REQUEST_URI']; // <-- "/foo/bar?test=abc" or "/foo/index.php/bar?test=abc" + $queryString = isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : ''; // <-- "test=abc" or "" + + // Physical path + if (strpos($requestUri, $scriptName) !== false) { + $physicalPath = $scriptName; // <-- Without rewriting + } else { + $physicalPath = str_replace('\\', '', dirname($scriptName)); // <-- With rewriting + } + $env['SCRIPT_NAME'] = rtrim($physicalPath, '/'); // <-- Remove trailing slashes + + // Virtual path + $env['PATH_INFO'] = substr_replace($requestUri, '', 0, strlen($physicalPath)); // <-- Remove physical path + $env['PATH_INFO'] = str_replace('?' . $queryString, '', $env['PATH_INFO']); // <-- Remove query string + $env['PATH_INFO'] = '/' . ltrim($env['PATH_INFO'], '/'); // <-- Ensure leading slash + + // Query string (without leading "?") + $env['QUERY_STRING'] = $queryString; + + //Name of server host that is running the script + $env['SERVER_NAME'] = $_SERVER['SERVER_NAME']; + + //Number of server port that is running the script + $env['SERVER_PORT'] = $_SERVER['SERVER_PORT']; + + //HTTP request headers (retains HTTP_ prefix to match $_SERVER) + $headers = \Slim\Http\Headers::extract($_SERVER); + foreach ($headers as $key => $value) { + $env[$key] = $value; + } + + //Is the application running under HTTPS or HTTP protocol? + $env['slim.url_scheme'] = empty($_SERVER['HTTPS']) || $_SERVER['HTTPS'] === 'off' ? 'http' : 'https'; + + //Input stream (readable one time only; not available for multipart/form-data requests) + $rawInput = @file_get_contents('php://input'); + if (!$rawInput) { + $rawInput = ''; + } + $env['slim.input'] = $rawInput; + + //Error stream + $env['slim.errors'] = @fopen('php://stderr', 'w'); + + $this->properties = $env; + } + } + + /** + * Array Access: Offset Exists + */ + public function offsetExists($offset) + { + return isset($this->properties[$offset]); + } + + /** + * Array Access: Offset Get + */ + public function offsetGet($offset) + { + if (isset($this->properties[$offset])) { + return $this->properties[$offset]; + } else { + return null; + } + } + + /** + * Array Access: Offset Set + */ + public function offsetSet($offset, $value) + { + $this->properties[$offset] = $value; + } + + /** + * Array Access: Offset Unset + */ + public function offsetUnset($offset) + { + unset($this->properties[$offset]); + } + + /** + * IteratorAggregate + * + * @return \ArrayIterator + */ + public function getIterator() + { + return new \ArrayIterator($this->properties); + } +} diff --git a/Slim/Exception/Pass.php b/Slim/Exception/Pass.php new file mode 100644 index 0000000..99d95c2 --- /dev/null +++ b/Slim/Exception/Pass.php @@ -0,0 +1,49 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Exception; + +/** + * Pass Exception + * + * This Exception will cause the Router::dispatch method + * to skip the current matching route and continue to the next + * matching route. If no subsequent routes are found, a + * HTTP 404 Not Found response will be sent to the client. + * + * @package Slim + * @author Josh Lockhart + * @since 1.0.0 + */ +class Pass extends \Exception +{ +} diff --git a/Slim/Exception/Stop.php b/Slim/Exception/Stop.php new file mode 100644 index 0000000..a251851 --- /dev/null +++ b/Slim/Exception/Stop.php @@ -0,0 +1,47 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Exception; + +/** + * Stop Exception + * + * This Exception is thrown when the Slim application needs to abort + * processing and return control flow to the outer PHP script. + * + * @package Slim + * @author Josh Lockhart + * @since 1.0.0 + */ +class Stop extends \Exception +{ +} diff --git a/Slim/Helper/Set.php b/Slim/Helper/Set.php new file mode 100644 index 0000000..9538b69 --- /dev/null +++ b/Slim/Helper/Set.php @@ -0,0 +1,246 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Helper; + +class Set implements \ArrayAccess, \Countable, \IteratorAggregate +{ + /** + * Key-value array of arbitrary data + * @var array + */ + protected $data = array(); + + /** + * Constructor + * @param array $items Pre-populate set with this key-value array + */ + public function __construct($items = array()) + { + $this->replace($items); + } + + /** + * Normalize data key + * + * Used to transform data key into the necessary + * key format for this set. Used in subclasses + * like \Slim\Http\Headers. + * + * @param string $key The data key + * @return mixed The transformed/normalized data key + */ + protected function normalizeKey($key) + { + return $key; + } + + /** + * Set data key to value + * @param string $key The data key + * @param mixed $value The data value + */ + public function set($key, $value) + { + $this->data[$this->normalizeKey($key)] = $value; + } + + /** + * Get data value with key + * @param string $key The data key + * @param mixed $default The value to return if data key does not exist + * @return mixed The data value, or the default value + */ + public function get($key, $default = null) + { + if ($this->has($key)) { + $isInvokable = is_object($this->data[$this->normalizeKey($key)]) && method_exists($this->data[$this->normalizeKey($key)], '__invoke'); + + return $isInvokable ? $this->data[$this->normalizeKey($key)]($this) : $this->data[$this->normalizeKey($key)]; + } + + return $default; + } + + /** + * Add data to set + * @param array $items Key-value array of data to append to this set + */ + public function replace($items) + { + foreach ($items as $key => $value) { + $this->set($key, $value); // Ensure keys are normalized + } + } + + /** + * Fetch set data + * @return array This set's key-value data array + */ + public function all() + { + return $this->data; + } + + /** + * Fetch set data keys + * @return array This set's key-value data array keys + */ + public function keys() + { + return array_keys($this->data); + } + + /** + * Does this set contain a key? + * @param string $key The data key + * @return boolean + */ + public function has($key) + { + return array_key_exists($this->normalizeKey($key), $this->data); + } + + /** + * Remove value with key from this set + * @param string $key The data key + */ + public function remove($key) + { + unset($this->data[$this->normalizeKey($key)]); + } + + /** + * Property Overloading + */ + + public function __get($key) + { + return $this->get($key); + } + + public function __set($key, $value) + { + $this->set($key, $value); + } + + public function __isset($key) + { + return $this->has($key); + } + + public function __unset($key) + { + return $this->remove($key); + } + + /** + * Clear all values + */ + public function clear() + { + $this->data = array(); + } + + /** + * Array Access + */ + + public function offsetExists($offset) + { + return $this->has($offset); + } + + public function offsetGet($offset) + { + return $this->get($offset); + } + + public function offsetSet($offset, $value) + { + $this->set($offset, $value); + } + + public function offsetUnset($offset) + { + $this->remove($offset); + } + + /** + * Countable + */ + + public function count() + { + return count($this->data); + } + + /** + * IteratorAggregate + */ + + public function getIterator() + { + return new \ArrayIterator($this->data); + } + + /** + * Ensure a value or object will remain globally unique + * @param string $key The value or object name + * @param Closure The closure that defines the object + * @return mixed + */ + public function singleton($key, $value) + { + $this->set($key, function ($c) use ($value) { + static $object; + + if (null === $object) { + $object = $value($c); + } + + return $object; + }); + } + + /** + * Protect closure from being directly invoked + * @param Closure $callable A closure to keep from being invoked and evaluated + * @return Closure + */ + public function protect(\Closure $callable) + { + return function () use ($callable) { + return $callable; + }; + } +} diff --git a/Slim/Http/Cookies.php b/Slim/Http/Cookies.php new file mode 100644 index 0000000..a2ed3e5 --- /dev/null +++ b/Slim/Http/Cookies.php @@ -0,0 +1,190 @@ + '', + 'domain' => null, + 'path' => null, + 'expires' => null, + 'secure' => false, + 'httponly' => false + ]; + + /** + * Create new cookies helper + * + * @param array $cookies + */ + public function __construct(array $cookies = []) + { + $this->requestCookies = $cookies; + } + + /** + * Set default cookie properties + * + * @param array $settings + */ + public function setDefaults(array $settings) + { + $this->defaults = array_replace($this->defaults, $settings); + } + + /** + * Get request cookie + * + * @param string $name Cookie name + * @param mixed $default Cookie default value + * + * @return mixed Cookie value if present, else default + */ + public function get($name, $default = null) + { + return isset($this->requestCookies[$name]) ? $this->requestCookies[$name] : $default; + } + + /** + * Set response cookie + * + * @param string $name Cookie name + * @param string|array $value Cookie value, or cookie properties + */ + public function set($name, $value) + { + if (!is_array($value)) { + $value = ['value' => (string)$value]; + } + $this->responseCookies[$name] = array_replace($this->defaults, $value); + } + + /** + * Convert to `Set-Cookie` headers + * + * @return string[] + */ + public function toHeaders() + { + $headers = []; + foreach ($this->responseCookies as $name => $properties) { + $headers[] = $this->toHeader($name, $properties); + } + + return $headers; + } + + /** + * Convert to `Set-Cookie` header + * + * @param string $name Cookie name + * @param array $properties Cookie properties + * + * @return string + */ + protected function toHeader($name, array $properties) + { + $result = urlencode($name) . '=' . urlencode($properties['value']); + + if (isset($properties['domain'])) { + $result .= '; domain=' . $properties['domain']; + } + + if (isset($properties['path'])) { + $result .= '; path=' . $properties['path']; + } + + if (isset($properties['expires'])) { + if (is_string($properties['expires'])) { + $timestamp = strtotime($properties['expires']); + } else { + $timestamp = (int)$properties['expires']; + } + if ($timestamp !== 0) { + $result .= '; expires=' . gmdate('D, d-M-Y H:i:s e', $timestamp); + } + } + + if (isset($properties['secure']) && $properties['secure']) { + $result .= '; secure'; + } + + if (isset($properties['httponly']) && $properties['httponly']) { + $result .= '; HttpOnly'; + } + + return $result; + } + + /** + * Parse HTTP request `Cookie:` header and extract + * into a PHP associative array. + * + * @param string $header The raw HTTP request `Cookie:` header + * + * @return array Associative array of cookie names and values + * + * @throws InvalidArgumentException if the cookie data cannot be parsed + */ + public static function parseHeader($header) + { + if (is_array($header) === true) { + $header = isset($header[0]) ? $header[0] : ''; + } + + if (is_string($header) === false) { + throw new InvalidArgumentException('Cannot parse Cookie data. Header value must be a string.'); + } + + $header = rtrim($header, "\r\n"); + $pieces = preg_split('@\s*[;,]\s*@', $header); + $cookies = []; + + foreach ($pieces as $cookie) { + $cookie = explode('=', $cookie, 2); + + if (count($cookie) === 2) { + $key = urldecode($cookie[0]); + $value = urldecode($cookie[1]); + + if (!isset($cookies[$key])) { + $cookies[$key] = $value; + } + } + } + + return $cookies; + } +} diff --git a/Slim/Http/Headers.php b/Slim/Http/Headers.php new file mode 100644 index 0000000..23a28b3 --- /dev/null +++ b/Slim/Http/Headers.php @@ -0,0 +1,197 @@ + 1, + 'CONTENT_LENGTH' => 1, + 'PHP_AUTH_USER' => 1, + 'PHP_AUTH_PW' => 1, + 'PHP_AUTH_DIGEST' => 1, + 'AUTH_TYPE' => 1, + ]; + + /** + * Create new headers collection with data extracted from + * the application Environment object + * + * @param Environment $environment The Slim application Environment + * + * @return self + */ + public static function createFromEnvironment(Environment $environment) + { + $data = []; + foreach ($environment as $key => $value) { + $key = strtoupper($key); + if (isset(static::$special[$key]) || strpos($key, 'HTTP_') === 0) { + if ($key !== 'HTTP_CONTENT_LENGTH') { + $data[$key] = $value; + } + } + } + + return new static($data); + } + + /** + * Return array of HTTP header names and values. + * This method returns the _original_ header name + * as specified by the end user. + * + * @return array + */ + public function all() + { + $all = parent::all(); + $out = []; + foreach ($all as $key => $props) { + $out[$props['originalKey']] = $props['value']; + } + + return $out; + } + + /** + * Set HTTP header value + * + * This method sets a header value. It replaces + * any values that may already exist for the header name. + * + * @param string $key The case-insensitive header name + * @param string $value The header value + */ + public function set($key, $value) + { + if (!is_array($value)) { + $value = [$value]; + } + parent::set($this->normalizeKey($key), [ + 'value' => $value, + 'originalKey' => $key + ]); + } + + /** + * Get HTTP header value + * + * @param string $key The case-insensitive header name + * @param mixed $default The default value if key does not exist + * + * @return string[] + */ + public function get($key, $default = null) + { + if ($this->has($key)) { + return parent::get($this->normalizeKey($key))['value']; + } + + return $default; + } + + /** + * Get HTTP header key as originally specified + * + * @param string $key The case-insensitive header name + * @param mixed $default The default value if key does not exist + * + * @return string + */ + public function getOriginalKey($key, $default = null) + { + if ($this->has($key)) { + return parent::get($this->normalizeKey($key))['originalKey']; + } + + return $default; + } + + /** + * Add HTTP header value + * + * This method appends a header value. Unlike the set() method, + * this method _appends_ this new value to any values + * that already exist for this header name. + * + * @param string $key The case-insensitive header name + * @param array|string $value The new header value(s) + */ + public function add($key, $value) + { + $oldValues = $this->get($key, []); + $newValues = is_array($value) ? $value : [$value]; + $this->set($key, array_merge($oldValues, array_values($newValues))); + } + + /** + * Does this collection have a given header? + * + * @param string $key The case-insensitive header name + * + * @return bool + */ + public function has($key) + { + return parent::has($this->normalizeKey($key)); + } + + /** + * Remove header from collection + * + * @param string $key The case-insensitive header name + */ + public function remove($key) + { + parent::remove($this->normalizeKey($key)); + } + + /** + * Normalize header name + * + * This method transforms header names into a + * normalized form. This is how we enable case-insensitive + * header names in the other methods in this class. + * + * @param string $key The case-insensitive header name + * + * @return string Normalized header name + */ + public function normalizeKey($key) + { + $key = strtr(strtolower($key), '_', '-'); + if (strpos($key, 'http-') === 0) { + $key = substr($key, 5); + } + + return $key; + } +} diff --git a/Slim/Http/Request.php b/Slim/Http/Request.php new file mode 100644 index 0000000..26744e5 --- /dev/null +++ b/Slim/Http/Request.php @@ -0,0 +1,1076 @@ + 1, + 'DELETE' => 1, + 'GET' => 1, + 'HEAD' => 1, + 'OPTIONS' => 1, + 'PATCH' => 1, + 'POST' => 1, + 'PUT' => 1, + 'TRACE' => 1, + ]; + + /** + * Create new HTTP request with data extracted from the application + * Environment object + * + * @param Environment $environment The Slim application Environment + * + * @return self + */ + public static function createFromEnvironment(Environment $environment) + { + $method = $environment['REQUEST_METHOD']; + $uri = Uri::createFromEnvironment($environment); + $headers = Headers::createFromEnvironment($environment); + $cookies = Cookies::parseHeader($headers->get('Cookie', [])); + $serverParams = $environment->all(); + $body = new RequestBody(); + $uploadedFiles = UploadedFile::createFromEnvironment($environment); + + $request = new static($method, $uri, $headers, $cookies, $serverParams, $body, $uploadedFiles); + + if ($method === 'POST' && + in_array($request->getMediaType(), ['application/x-www-form-urlencoded', 'multipart/form-data']) + ) { + // parsed body must be $_POST + $request = $request->withParsedBody($_POST); + } + return $request; + } + + /** + * Create new HTTP request. + * + * Adds a host header when none was provided and a host is defined in uri. + * + * @param string $method The request method + * @param UriInterface $uri The request URI object + * @param HeadersInterface $headers The request headers collection + * @param array $cookies The request cookies collection + * @param array $serverParams The server environment variables + * @param StreamInterface $body The request body object + * @param array $uploadedFiles The request uploadedFiles collection + */ + public function __construct($method, UriInterface $uri, HeadersInterface $headers, array $cookies, array $serverParams, StreamInterface $body, array $uploadedFiles = []) + { + $this->originalMethod = $this->filterMethod($method); + $this->uri = $uri; + $this->headers = $headers; + $this->cookies = $cookies; + $this->serverParams = $serverParams; + $this->attributes = new Collection(); + $this->body = $body; + $this->uploadedFiles = $uploadedFiles; + + if (!$this->headers->has('Host') || $this->uri->getHost() !== '') { + $this->headers->set('Host', $this->uri->getHost()); + } + + $this->registerMediaTypeParser('application/json', function ($input) { + return json_decode($input, true); + }); + + $this->registerMediaTypeParser('application/xml', function ($input) { + $backup = libxml_disable_entity_loader(true); + $result = simplexml_load_string($input); + libxml_disable_entity_loader($backup); + return $result; + }); + + $this->registerMediaTypeParser('text/xml', function ($input) { + $backup = libxml_disable_entity_loader(true); + $result = simplexml_load_string($input); + libxml_disable_entity_loader($backup); + return $result; + }); + + $this->registerMediaTypeParser('application/x-www-form-urlencoded', function ($input) { + parse_str($input, $data); + return $data; + }); + } + + /** + * This method is applied to the cloned object + * after PHP performs an initial shallow-copy. This + * method completes a deep-copy by creating new objects + * for the cloned object's internal reference pointers. + */ + public function __clone() + { + $this->headers = clone $this->headers; + $this->attributes = clone $this->attributes; + $this->body = clone $this->body; + } + + /******************************************************************************* + * Method + ******************************************************************************/ + + /** + * Retrieves the HTTP method of the request. + * + * @return string Returns the request method. + */ + public function getMethod() + { + if ($this->method === null) { + $this->method = $this->originalMethod; + $customMethod = $this->getHeaderLine('X-Http-Method-Override'); + + if ($customMethod) { + $this->method = $this->filterMethod($customMethod); + } elseif ($this->originalMethod === 'POST') { + $body = $this->getParsedBody(); + + if (is_object($body) && property_exists($body, '_METHOD')) { + $this->method = $this->filterMethod((string)$body->_METHOD); + } elseif (is_array($body) && isset($body['_METHOD'])) { + $this->method = $this->filterMethod((string)$body['_METHOD']); + } + + if ($this->getBody()->eof()) { + $this->getBody()->rewind(); + } + } + } + + return $this->method; + } + + /** + * Get the original HTTP method (ignore override). + * + * Note: This method is not part of the PSR-7 standard. + * + * @return string + */ + public function getOriginalMethod() + { + return $this->originalMethod; + } + + /** + * Return an instance with the provided HTTP method. + * + * While HTTP method names are typically all uppercase characters, HTTP + * method names are case-sensitive and thus implementations SHOULD NOT + * modify the given string. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * changed request method. + * + * @param string $method Case-sensitive method. + * @return self + * @throws \InvalidArgumentException for invalid HTTP methods. + */ + public function withMethod($method) + { + $method = $this->filterMethod($method); + $clone = clone $this; + $clone->originalMethod = $method; + $clone->method = $method; + + return $clone; + } + + /** + * Validate the HTTP method + * + * @param null|string $method + * @return null|string + * @throws \InvalidArgumentException on invalid HTTP method. + */ + protected function filterMethod($method) + { + if ($method === null) { + return $method; + } + + if (!is_string($method)) { + throw new InvalidArgumentException(sprintf( + 'Unsupported HTTP method; must be a string, received %s', + (is_object($method) ? get_class($method) : gettype($method)) + )); + } + + $method = strtoupper($method); + if (!isset($this->validMethods[$method])) { + throw new InvalidArgumentException(sprintf( + 'Unsupported HTTP method "%s" provided', + $method + )); + } + + return $method; + } + + /** + * Does this request use a given method? + * + * Note: This method is not part of the PSR-7 standard. + * + * @param string $method HTTP method + * @return bool + */ + public function isMethod($method) + { + return $this->getMethod() === $method; + } + + /** + * Is this a GET request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isGet() + { + return $this->isMethod('GET'); + } + + /** + * Is this a POST request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isPost() + { + return $this->isMethod('POST'); + } + + /** + * Is this a PUT request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isPut() + { + return $this->isMethod('PUT'); + } + + /** + * Is this a PATCH request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isPatch() + { + return $this->isMethod('PATCH'); + } + + /** + * Is this a DELETE request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isDelete() + { + return $this->isMethod('DELETE'); + } + + /** + * Is this a HEAD request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isHead() + { + return $this->isMethod('HEAD'); + } + + /** + * Is this a OPTIONS request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isOptions() + { + return $this->isMethod('OPTIONS'); + } + + /** + * Is this an XHR request? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isXhr() + { + return $this->getHeaderLine('X-Requested-With') === 'XMLHttpRequest'; + } + + /******************************************************************************* + * URI + ******************************************************************************/ + + /** + * Retrieves the message's request target. + * + * Retrieves the message's request-target either as it will appear (for + * clients), as it appeared at request (for servers), or as it was + * specified for the instance (see withRequestTarget()). + * + * In most cases, this will be the origin-form of the composed URI, + * unless a value was provided to the concrete implementation (see + * withRequestTarget() below). + * + * If no URI is available, and no request-target has been specifically + * provided, this method MUST return the string "/". + * + * @return string + */ + public function getRequestTarget() + { + if ($this->requestTarget) { + return $this->requestTarget; + } + + if ($this->uri === null) { + return '/'; + } + + $basePath = $this->uri->getBasePath(); + $path = $this->uri->getPath(); + $path = $basePath . '/' . ltrim($path, '/'); + + $query = $this->uri->getQuery(); + if ($query) { + $path .= '?' . $query; + } + $this->requestTarget = $path; + + return $this->requestTarget; + } + + /** + * Return an instance with the specific request-target. + * + * If the request needs a non-origin-form request-target — e.g., for + * specifying an absolute-form, authority-form, or asterisk-form — + * this method may be used to create an instance with the specified + * request-target, verbatim. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * changed request target. + * + * @link http://tools.ietf.org/html/rfc7230#section-2.7 (for the various + * request-target forms allowed in request messages) + * @param mixed $requestTarget + * @return self + * @throws InvalidArgumentException if the request target is invalid + */ + public function withRequestTarget($requestTarget) + { + if (preg_match('#\s#', $requestTarget)) { + throw new InvalidArgumentException( + 'Invalid request target provided; must be a string and cannot contain whitespace' + ); + } + $clone = clone $this; + $clone->requestTarget = $requestTarget; + + return $clone; + } + + /** + * Retrieves the URI instance. + * + * This method MUST return a UriInterface instance. + * + * @link http://tools.ietf.org/html/rfc3986#section-4.3 + * @return UriInterface Returns a UriInterface instance + * representing the URI of the request. + */ + public function getUri() + { + return $this->uri; + } + + /** + * Returns an instance with the provided URI. + * + * This method MUST update the Host header of the returned request by + * default if the URI contains a host component. If the URI does not + * contain a host component, any pre-existing Host header MUST be carried + * over to the returned request. + * + * You can opt-in to preserving the original state of the Host header by + * setting `$preserveHost` to `true`. When `$preserveHost` is set to + * `true`, this method interacts with the Host header in the following ways: + * + * - If the the Host header is missing or empty, and the new URI contains + * a host component, this method MUST update the Host header in the returned + * request. + * - If the Host header is missing or empty, and the new URI does not contain a + * host component, this method MUST NOT update the Host header in the returned + * request. + * - If a Host header is present and non-empty, this method MUST NOT update + * the Host header in the returned request. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * new UriInterface instance. + * + * @link http://tools.ietf.org/html/rfc3986#section-4.3 + * @param UriInterface $uri New request URI to use. + * @param bool $preserveHost Preserve the original state of the Host header. + * @return self + */ + public function withUri(UriInterface $uri, $preserveHost = false) + { + $clone = clone $this; + $clone->uri = $uri; + + if (!$preserveHost) { + if ($uri->getHost() !== '') { + $clone->headers->set('Host', $uri->getHost()); + } + } else { + if ($this->uri->getHost() !== '' && (!$this->hasHeader('Host') || $this->getHeader('Host') === null)) { + $clone->headers->set('Host', $uri->getHost()); + } + } + + return $clone; + } + + /** + * Get request content type. + * + * Note: This method is not part of the PSR-7 standard. + * + * @return string|null The request content type, if known + */ + public function getContentType() + { + $result = $this->getHeader('Content-Type'); + + return $result ? $result[0] : null; + } + + /** + * Get request media type, if known. + * + * Note: This method is not part of the PSR-7 standard. + * + * @return string|null The request media type, minus content-type params + */ + public function getMediaType() + { + $contentType = $this->getContentType(); + if ($contentType) { + $contentTypeParts = preg_split('/\s*[;,]\s*/', $contentType); + + return strtolower($contentTypeParts[0]); + } + + return null; + } + + /** + * Get request media type params, if known. + * + * Note: This method is not part of the PSR-7 standard. + * + * @return array + */ + public function getMediaTypeParams() + { + $contentType = $this->getContentType(); + $contentTypeParams = []; + if ($contentType) { + $contentTypeParts = preg_split('/\s*[;,]\s*/', $contentType); + $contentTypePartsLength = count($contentTypeParts); + for ($i = 1; $i < $contentTypePartsLength; $i++) { + $paramParts = explode('=', $contentTypeParts[$i]); + $contentTypeParams[strtolower($paramParts[0])] = $paramParts[1]; + } + } + + return $contentTypeParams; + } + + /** + * Get request content character set, if known. + * + * Note: This method is not part of the PSR-7 standard. + * + * @return string|null + */ + public function getContentCharset() + { + $mediaTypeParams = $this->getMediaTypeParams(); + if (isset($mediaTypeParams['charset'])) { + return $mediaTypeParams['charset']; + } + + return null; + } + + /** + * Get request content length, if known. + * + * Note: This method is not part of the PSR-7 standard. + * + * @return int|null + */ + public function getContentLength() + { + $result = $this->headers->get('Content-Length'); + + return $result ? (int)$result[0] : null; + } + + /******************************************************************************* + * Cookies + ******************************************************************************/ + + /** + * Retrieve cookies. + * + * Retrieves cookies sent by the client to the server. + * + * The data MUST be compatible with the structure of the $_COOKIE + * superglobal. + * + * @return array + */ + public function getCookieParams() + { + return $this->cookies; + } + + /** + * Return an instance with the specified cookies. + * + * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST + * be compatible with the structure of $_COOKIE. Typically, this data will + * be injected at instantiation. + * + * This method MUST NOT update the related Cookie header of the request + * instance, nor related values in the server params. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated cookie values. + * + * @param array $cookies Array of key/value pairs representing cookies. + * @return self + */ + public function withCookieParams(array $cookies) + { + $clone = clone $this; + $clone->cookies = $cookies; + + return $clone; + } + + /******************************************************************************* + * Query Params + ******************************************************************************/ + + /** + * Retrieve query string arguments. + * + * Retrieves the deserialized query string arguments, if any. + * + * Note: the query params might not be in sync with the URI or server + * params. If you need to ensure you are only getting the original + * values, you may need to parse the query string from `getUri()->getQuery()` + * or from the `QUERY_STRING` server param. + * + * @return array + */ + public function getQueryParams() + { + if ($this->queryParams) { + return $this->queryParams; + } + + if ($this->uri === null) { + return []; + } + + parse_str($this->uri->getQuery(), $this->queryParams); // <-- URL decodes data + + return $this->queryParams; + } + + /** + * Return an instance with the specified query string arguments. + * + * These values SHOULD remain immutable over the course of the incoming + * request. They MAY be injected during instantiation, such as from PHP's + * $_GET superglobal, or MAY be derived from some other value such as the + * URI. In cases where the arguments are parsed from the URI, the data + * MUST be compatible with what PHP's parse_str() would return for + * purposes of how duplicate query parameters are handled, and how nested + * sets are handled. + * + * Setting query string arguments MUST NOT change the URI stored by the + * request, nor the values in the server params. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated query string arguments. + * + * @param array $query Array of query string arguments, typically from + * $_GET. + * @return self + */ + public function withQueryParams(array $query) + { + $clone = clone $this; + $clone->queryParams = $query; + + return $clone; + } + + /******************************************************************************* + * File Params + ******************************************************************************/ + + /** + * Retrieve normalized file upload data. + * + * This method returns upload metadata in a normalized tree, with each leaf + * an instance of Psr\Http\Message\UploadedFileInterface. + * + * These values MAY be prepared from $_FILES or the message body during + * instantiation, or MAY be injected via withUploadedFiles(). + * + * @return array An array tree of UploadedFileInterface instances; an empty + * array MUST be returned if no data is present. + */ + public function getUploadedFiles() + { + return $this->uploadedFiles; + } + + /** + * Create a new instance with the specified uploaded files. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated body parameters. + * + * @param array $uploadedFiles An array tree of UploadedFileInterface instances. + * @return self + * @throws \InvalidArgumentException if an invalid structure is provided. + */ + public function withUploadedFiles(array $uploadedFiles) + { + $clone = clone $this; + $clone->uploadedFiles = $uploadedFiles; + + return $clone; + } + + /******************************************************************************* + * Server Params + ******************************************************************************/ + + /** + * Retrieve server parameters. + * + * Retrieves data related to the incoming request environment, + * typically derived from PHP's $_SERVER superglobal. The data IS NOT + * REQUIRED to originate from $_SERVER. + * + * @return array + */ + public function getServerParams() + { + return $this->serverParams; + } + + /******************************************************************************* + * Attributes + ******************************************************************************/ + + /** + * Retrieve attributes derived from the request. + * + * The request "attributes" may be used to allow injection of any + * parameters derived from the request: e.g., the results of path + * match operations; the results of decrypting cookies; the results of + * deserializing non-form-encoded message bodies; etc. Attributes + * will be application and request specific, and CAN be mutable. + * + * @return array Attributes derived from the request. + */ + public function getAttributes() + { + return $this->attributes->all(); + } + + /** + * Retrieve a single derived request attribute. + * + * Retrieves a single derived request attribute as described in + * getAttributes(). If the attribute has not been previously set, returns + * the default value as provided. + * + * This method obviates the need for a hasAttribute() method, as it allows + * specifying a default value to return if the attribute is not found. + * + * @see getAttributes() + * @param string $name The attribute name. + * @param mixed $default Default value to return if the attribute does not exist. + * @return mixed + */ + public function getAttribute($name, $default = null) + { + return $this->attributes->get($name, $default); + } + + /** + * Return an instance with the specified derived request attribute. + * + * This method allows setting a single derived request attribute as + * described in getAttributes(). + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated attribute. + * + * @see getAttributes() + * @param string $name The attribute name. + * @param mixed $value The value of the attribute. + * @return self + */ + public function withAttribute($name, $value) + { + $clone = clone $this; + $clone->attributes->set($name, $value); + + return $clone; + } + + /** + * Create a new instance with the specified derived request attributes. + * + * Note: This method is not part of the PSR-7 standard. + * + * This method allows setting all new derived request attributes as + * described in getAttributes(). + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return a new instance that has the + * updated attributes. + * + * @param array $attributes New attributes + * @return self + */ + public function withAttributes(array $attributes) + { + $clone = clone $this; + $clone->attributes = new Collection($attributes); + + return $clone; + } + + /** + * Return an instance that removes the specified derived request attribute. + * + * This method allows removing a single derived request attribute as + * described in getAttributes(). + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that removes + * the attribute. + * + * @see getAttributes() + * @param string $name The attribute name. + * @return self + */ + public function withoutAttribute($name) + { + $clone = clone $this; + $clone->attributes->remove($name); + + return $clone; + } + + /******************************************************************************* + * Body + ******************************************************************************/ + + /** + * Retrieve any parameters provided in the request body. + * + * If the request Content-Type is either application/x-www-form-urlencoded + * or multipart/form-data, and the request method is POST, this method MUST + * return the contents of $_POST. + * + * Otherwise, this method may return any results of deserializing + * the request body content; as parsing returns structured content, the + * potential types MUST be arrays or objects only. A null value indicates + * the absence of body content. + * + * @return null|array|object The deserialized body parameters, if any. + * These will typically be an array or object. + * @throws RuntimeException if the request body media type parser returns an invalid value + */ + public function getParsedBody() + { + if ($this->bodyParsed) { + return $this->bodyParsed; + } + + if (!$this->body) { + return null; + } + + $mediaType = $this->getMediaType(); + $body = (string)$this->getBody(); + + if (isset($this->bodyParsers[$mediaType]) === true) { + $parsed = $this->bodyParsers[$mediaType]($body); + + if (!is_null($parsed) && !is_object($parsed) && !is_array($parsed)) { + throw new RuntimeException('Request body media type parser return value must be an array, an object, or null'); + } + $this->bodyParsed = $parsed; + } + + return $this->bodyParsed; + } + + /** + * Return an instance with the specified body parameters. + * + * These MAY be injected during instantiation. + * + * If the request Content-Type is either application/x-www-form-urlencoded + * or multipart/form-data, and the request method is POST, use this method + * ONLY to inject the contents of $_POST. + * + * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of + * deserializing the request body content. Deserialization/parsing returns + * structured data, and, as such, this method ONLY accepts arrays or objects, + * or a null value if nothing was available to parse. + * + * As an example, if content negotiation determines that the request data + * is a JSON payload, this method could be used to create a request + * instance with the deserialized parameters. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated body parameters. + * + * @param null|array|object $data The deserialized body data. This will + * typically be in an array or object. + * @return self + * @throws \InvalidArgumentException if an unsupported argument type is + * provided. + */ + public function withParsedBody($data) + { + if (!is_null($data) && !is_object($data) && !is_array($data)) { + throw new InvalidArgumentException('Parsed body value must be an array, an object, or null'); + } + + $clone = clone $this; + $clone->bodyParsed = $data; + + return $clone; + } + + /** + * Register media type parser. + * + * Note: This method is not part of the PSR-7 standard. + * + * @param string $mediaType A HTTP media type (excluding content-type + * params). + * @param callable $callable A callable that returns parsed contents for + * media type. + */ + public function registerMediaTypeParser($mediaType, callable $callable) + { + if ($callable instanceof Closure) { + $callable = $callable->bindTo($this); + } + $this->bodyParsers[(string)$mediaType] = $callable; + } + + /******************************************************************************* + * Parameters (e.g., POST and GET data) + ******************************************************************************/ + + /** + * Fetch request parameter value from body or query string (in that order). + * + * Note: This method is not part of the PSR-7 standard. + * + * @param string $key The parameter key. + * @param string $default The default value. + * + * @return mixed The parameter value. + */ + public function getParam($key, $default = null) + { + $postParams = $this->getParsedBody(); + $getParams = $this->getQueryParams(); + $result = $default; + if (is_array($postParams) && isset($postParams[$key])) { + $result = $postParams[$key]; + } elseif (is_object($postParams) && property_exists($postParams, $key)) { + $result = $postParams->$key; + } elseif (isset($getParams[$key])) { + $result = $getParams[$key]; + } + + return $result; + } + + /** + * Fetch assocative array of body and query string parameters. + * + * @return array + */ + public function getParams() + { + $params = $this->getQueryParams(); + $postParams = $this->getParsedBody(); + if ($postParams) { + $params = array_merge($params, (array)$postParams); + } + + return $params; + } +} diff --git a/Slim/Http/Response.php b/Slim/Http/Response.php new file mode 100644 index 0000000..2644c8a --- /dev/null +++ b/Slim/Http/Response.php @@ -0,0 +1,450 @@ + 'Continue', + 101 => 'Switching Protocols', + 102 => 'Processing', + //Successful 2xx + 200 => 'OK', + 201 => 'Created', + 202 => 'Accepted', + 203 => 'Non-Authoritative Information', + 204 => 'No Content', + 205 => 'Reset Content', + 206 => 'Partial Content', + 207 => 'Multi-Status', + 208 => 'Already Reported', + 226 => 'IM Used', + //Redirection 3xx + 300 => 'Multiple Choices', + 301 => 'Moved Permanently', + 302 => 'Found', + 303 => 'See Other', + 304 => 'Not Modified', + 305 => 'Use Proxy', + 306 => '(Unused)', + 307 => 'Temporary Redirect', + 308 => 'Permanent Redirect', + //Client Error 4xx + 400 => 'Bad Request', + 401 => 'Unauthorized', + 402 => 'Payment Required', + 403 => 'Forbidden', + 404 => 'Not Found', + 405 => 'Method Not Allowed', + 406 => 'Not Acceptable', + 407 => 'Proxy Authentication Required', + 408 => 'Request Timeout', + 409 => 'Conflict', + 410 => 'Gone', + 411 => 'Length Required', + 412 => 'Precondition Failed', + 413 => 'Request Entity Too Large', + 414 => 'Request-URI Too Long', + 415 => 'Unsupported Media Type', + 416 => 'Requested Range Not Satisfiable', + 417 => 'Expectation Failed', + 418 => 'I\'m a teapot', + 422 => 'Unprocessable Entity', + 423 => 'Locked', + 424 => 'Failed Dependency', + 426 => 'Upgrade Required', + 428 => 'Precondition Required', + 429 => 'Too Many Requests', + 431 => 'Request Header Fields Too Large', + //Server Error 5xx + 500 => 'Internal Server Error', + 501 => 'Not Implemented', + 502 => 'Bad Gateway', + 503 => 'Service Unavailable', + 504 => 'Gateway Timeout', + 505 => 'HTTP Version Not Supported', + 506 => 'Variant Also Negotiates', + 507 => 'Insufficient Storage', + 508 => 'Loop Detected', + 510 => 'Not Extended', + 511 => 'Network Authentication Required', + ]; + + /** + * Create new HTTP response. + * + * @param int $status The response status code. + * @param HeadersInterface|null $headers The response headers. + * @param StreamInterface|null $body The response body. + */ + public function __construct($status = 200, HeadersInterface $headers = null, StreamInterface $body = null) + { + $this->status = $this->filterStatus($status); + $this->headers = $headers ? $headers : new Headers(); + $this->body = $body ? $body : new Body(fopen('php://temp', 'r+')); + } + + /** + * This method is applied to the cloned object + * after PHP performs an initial shallow-copy. This + * method completes a deep-copy by creating new objects + * for the cloned object's internal reference pointers. + */ + public function __clone() + { + $this->headers = clone $this->headers; + $this->body = clone $this->body; + } + + /******************************************************************************* + * Status + ******************************************************************************/ + + /** + * Gets the response status code. + * + * The status code is a 3-digit integer result code of the server's attempt + * to understand and satisfy the request. + * + * @return int Status code. + */ + public function getStatusCode() + { + return $this->status; + } + + /** + * Return an instance with the specified status code and, optionally, reason phrase. + * + * If no reason phrase is specified, implementations MAY choose to default + * to the RFC 7231 or IANA recommended reason phrase for the response's + * status code. + * + * This method MUST be implemented in such a way as to retain the + * immutability of the message, and MUST return an instance that has the + * updated status and reason phrase. + * + * @link http://tools.ietf.org/html/rfc7231#section-6 + * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml + * @param int $code The 3-digit integer result code to set. + * @param string $reasonPhrase The reason phrase to use with the + * provided status code; if none is provided, implementations MAY + * use the defaults as suggested in the HTTP specification. + * @return self + * @throws \InvalidArgumentException For invalid status code arguments. + */ + public function withStatus($code, $reasonPhrase = '') + { + $code = $this->filterStatus($code); + + if (!is_string($reasonPhrase) && !method_exists($reasonPhrase, '__toString')) { + throw new InvalidArgumentException('ReasonPhrase must be a string'); + } + + $clone = clone $this; + $clone->status = $code; + if ($reasonPhrase === '' && isset(static::$messages[$code])) { + $reasonPhrase = static::$messages[$code]; + } + + if ($reasonPhrase === '') { + throw new InvalidArgumentException('ReasonPhrase must be supplied for this code'); + } + + $clone->reasonPhrase = $reasonPhrase; + + return $clone; + } + + /** + * Filter HTTP status code. + * + * @param int $status HTTP status code. + * @return int + * @throws \InvalidArgumentException If an invalid HTTP status code is provided. + */ + protected function filterStatus($status) + { + if (!is_integer($status) || $status<100 || $status>599) { + throw new InvalidArgumentException('Invalid HTTP status code'); + } + + return $status; + } + + /** + * Gets the response reason phrase associated with the status code. + * + * Because a reason phrase is not a required element in a response + * status line, the reason phrase value MAY be null. Implementations MAY + * choose to return the default RFC 7231 recommended reason phrase (or those + * listed in the IANA HTTP Status Code Registry) for the response's + * status code. + * + * @link http://tools.ietf.org/html/rfc7231#section-6 + * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml + * @return string Reason phrase; must return an empty string if none present. + */ + public function getReasonPhrase() + { + if ($this->reasonPhrase) { + return $this->reasonPhrase; + } + if (isset(static::$messages[$this->status])) { + return static::$messages[$this->status]; + } + return ''; + } + + /******************************************************************************* + * Body + ******************************************************************************/ + + /** + * Write data to the response body. + * + * Note: This method is not part of the PSR-7 standard. + * + * Proxies to the underlying stream and writes the provided data to it. + * + * @param string $data + * @return self + */ + public function write($data) + { + $this->getBody()->write($data); + + return $this; + } + + /******************************************************************************* + * Response Helpers + ******************************************************************************/ + + /** + * Redirect. + * + * Note: This method is not part of the PSR-7 standard. + * + * This method prepares the response object to return an HTTP Redirect + * response to the client. + * + * @param string|UriInterface $url The redirect destination. + * @param int $status The redirect HTTP status code. + * @return self + */ + public function withRedirect($url, $status = 302) + { + return $this->withStatus($status)->withHeader('Location', (string)$url); + } + + /** + * Json. + * + * Note: This method is not part of the PSR-7 standard. + * + * This method prepares the response object to return an HTTP Json + * response to the client. + * + * @param mixed $data The data + * @param int $status The HTTP status code. + * @param int $encodingOptions Json encoding options + * @return self + */ + public function withJson($data, $status = 200, $encodingOptions = 0) + { + $body = $this->getBody(); + $body->rewind(); + $body->write(json_encode($data, $encodingOptions)); + + return $this->withStatus($status)->withHeader('Content-Type', 'application/json;charset=utf-8'); + } + + /** + * Is this response empty? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isEmpty() + { + return in_array($this->getStatusCode(), [204, 205, 304]); + } + + /** + * Is this response informational? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isInformational() + { + return $this->getStatusCode() >= 100 && $this->getStatusCode() < 200; + } + + /** + * Is this response OK? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isOk() + { + return $this->getStatusCode() === 200; + } + + /** + * Is this response successful? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isSuccessful() + { + return $this->getStatusCode() >= 200 && $this->getStatusCode() < 300; + } + + /** + * Is this response a redirect? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isRedirect() + { + return in_array($this->getStatusCode(), [301, 302, 303, 307]); + } + + /** + * Is this response a redirection? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isRedirection() + { + return $this->getStatusCode() >= 300 && $this->getStatusCode() < 400; + } + + /** + * Is this response forbidden? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + * @api + */ + public function isForbidden() + { + return $this->getStatusCode() === 403; + } + + /** + * Is this response not Found? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isNotFound() + { + return $this->getStatusCode() === 404; + } + + /** + * Is this response a client error? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isClientError() + { + return $this->getStatusCode() >= 400 && $this->getStatusCode() < 500; + } + + /** + * Is this response a server error? + * + * Note: This method is not part of the PSR-7 standard. + * + * @return bool + */ + public function isServerError() + { + return $this->getStatusCode() >= 500 && $this->getStatusCode() < 600; + } + + /** + * Convert response to string. + * + * Note: This method is not part of the PSR-7 standard. + * + * @return string + */ + public function __toString() + { + $output = sprintf( + 'HTTP/%s %s %s', + $this->getProtocolVersion(), + $this->getStatusCode(), + $this->getReasonPhrase() + ); + $output .= PHP_EOL; + foreach ($this->getHeaders() as $name => $values) { + $output .= sprintf('%s: %s', $name, $this->getHeaderLine($name)) . PHP_EOL; + } + $output .= PHP_EOL; + $output .= (string)$this->getBody(); + + return $output; + } +} diff --git a/Slim/Http/Util.php b/Slim/Http/Util.php new file mode 100644 index 0000000..dafedb3 --- /dev/null +++ b/Slim/Http/Util.php @@ -0,0 +1,434 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Http; + +/** + * Slim HTTP Utilities + * + * This class provides useful methods for handling HTTP requests. + * + * @package Slim + * @author Josh Lockhart + * @since 1.0.0 + */ +class Util +{ + /** + * Strip slashes from string or array + * + * This method strips slashes from its input. By default, this method will only + * strip slashes from its input if magic quotes are enabled. Otherwise, you may + * override the magic quotes setting with either TRUE or FALSE as the send argument + * to force this method to strip or not strip slashes from its input. + * + * @param array|string $rawData + * @param bool $overrideStripSlashes + * @return array|string + */ + public static function stripSlashesIfMagicQuotes($rawData, $overrideStripSlashes = null) + { + $strip = is_null($overrideStripSlashes) ? get_magic_quotes_gpc() : $overrideStripSlashes; + if ($strip) { + return self::stripSlashes($rawData); + } else { + return $rawData; + } + } + + /** + * Strip slashes from string or array + * @param array|string $rawData + * @return array|string + */ + protected static function stripSlashes($rawData) + { + return is_array($rawData) ? array_map(array('self', 'stripSlashes'), $rawData) : stripslashes($rawData); + } + + /** + * Encrypt data + * + * This method will encrypt data using a given key, vector, and cipher. + * By default, this will encrypt data using the RIJNDAEL/AES 256 bit cipher. You + * may override the default cipher and cipher mode by passing your own desired + * cipher and cipher mode as the final key-value array argument. + * + * @param string $data The unencrypted data + * @param string $key The encryption key + * @param string $iv The encryption initialization vector + * @param array $settings Optional key-value array with custom algorithm and mode + * @return string + */ + public static function encrypt($data, $key, $iv, $settings = array()) + { + if ($data === '' || !extension_loaded('mcrypt')) { + return $data; + } + + //Merge settings with defaults + $defaults = array( + 'algorithm' => MCRYPT_RIJNDAEL_256, + 'mode' => MCRYPT_MODE_CBC + ); + $settings = array_merge($defaults, $settings); + + //Get module + $module = mcrypt_module_open($settings['algorithm'], '', $settings['mode'], ''); + + //Validate IV + $ivSize = mcrypt_enc_get_iv_size($module); + if (strlen($iv) > $ivSize) { + $iv = substr($iv, 0, $ivSize); + } + + //Validate key + $keySize = mcrypt_enc_get_key_size($module); + if (strlen($key) > $keySize) { + $key = substr($key, 0, $keySize); + } + + //Encrypt value + mcrypt_generic_init($module, $key, $iv); + $res = @mcrypt_generic($module, $data); + mcrypt_generic_deinit($module); + + return $res; + } + + /** + * Decrypt data + * + * This method will decrypt data using a given key, vector, and cipher. + * By default, this will decrypt data using the RIJNDAEL/AES 256 bit cipher. You + * may override the default cipher and cipher mode by passing your own desired + * cipher and cipher mode as the final key-value array argument. + * + * @param string $data The encrypted data + * @param string $key The encryption key + * @param string $iv The encryption initialization vector + * @param array $settings Optional key-value array with custom algorithm and mode + * @return string + */ + public static function decrypt($data, $key, $iv, $settings = array()) + { + if ($data === '' || !extension_loaded('mcrypt')) { + return $data; + } + + //Merge settings with defaults + $defaults = array( + 'algorithm' => MCRYPT_RIJNDAEL_256, + 'mode' => MCRYPT_MODE_CBC + ); + $settings = array_merge($defaults, $settings); + + //Get module + $module = mcrypt_module_open($settings['algorithm'], '', $settings['mode'], ''); + + //Validate IV + $ivSize = mcrypt_enc_get_iv_size($module); + if (strlen($iv) > $ivSize) { + $iv = substr($iv, 0, $ivSize); + } + + //Validate key + $keySize = mcrypt_enc_get_key_size($module); + if (strlen($key) > $keySize) { + $key = substr($key, 0, $keySize); + } + + //Decrypt value + mcrypt_generic_init($module, $key, $iv); + $decryptedData = @mdecrypt_generic($module, $data); + $res = rtrim($decryptedData, "\0"); + mcrypt_generic_deinit($module); + + return $res; + } + + /** + * Serialize Response cookies into raw HTTP header + * @param \Slim\Http\Headers $headers The Response headers + * @param \Slim\Http\Cookies $cookies The Response cookies + * @param array $config The Slim app settings + */ + public static function serializeCookies(\Slim\Http\Headers &$headers, \Slim\Http\Cookies $cookies, array $config) + { + if ($config['cookies.encrypt']) { + foreach ($cookies as $name => $settings) { + if (is_string($settings['expires'])) { + $expires = strtotime($settings['expires']); + } else { + $expires = (int) $settings['expires']; + } + + $settings['value'] = static::encodeSecureCookie( + $settings['value'], + $expires, + $config['cookies.secret_key'], + $config['cookies.cipher'], + $config['cookies.cipher_mode'] + ); + static::setCookieHeader($headers, $name, $settings); + } + } else { + foreach ($cookies as $name => $settings) { + static::setCookieHeader($headers, $name, $settings); + } + } + } + + /** + * Encode secure cookie value + * + * This method will create the secure value of an HTTP cookie. The + * cookie value is encrypted and hashed so that its value is + * secure and checked for integrity when read in subsequent requests. + * + * @param string $value The insecure HTTP cookie value + * @param int $expires The UNIX timestamp at which this cookie will expire + * @param string $secret The secret key used to hash the cookie value + * @param int $algorithm The algorithm to use for encryption + * @param int $mode The algorithm mode to use for encryption + * @return string + */ + public static function encodeSecureCookie($value, $expires, $secret, $algorithm, $mode) + { + $key = hash_hmac('sha1', (string) $expires, $secret); + $iv = self::getIv($expires, $secret); + $secureString = base64_encode( + self::encrypt( + $value, + $key, + $iv, + array( + 'algorithm' => $algorithm, + 'mode' => $mode + ) + ) + ); + $verificationString = hash_hmac('sha1', $expires . $value, $key); + + return implode('|', array($expires, $secureString, $verificationString)); + } + + /** + * Decode secure cookie value + * + * This method will decode the secure value of an HTTP cookie. The + * cookie value is encrypted and hashed so that its value is + * secure and checked for integrity when read in subsequent requests. + * + * @param string $value The secure HTTP cookie value + * @param string $secret The secret key used to hash the cookie value + * @param int $algorithm The algorithm to use for encryption + * @param int $mode The algorithm mode to use for encryption + * @return bool|string + */ + public static function decodeSecureCookie($value, $secret, $algorithm, $mode) + { + if ($value) { + $value = explode('|', $value); + if (count($value) === 3 && ((int) $value[0] === 0 || (int) $value[0] > time())) { + $key = hash_hmac('sha1', $value[0], $secret); + $iv = self::getIv($value[0], $secret); + $data = self::decrypt( + base64_decode($value[1]), + $key, + $iv, + array( + 'algorithm' => $algorithm, + 'mode' => $mode + ) + ); + $verificationString = hash_hmac('sha1', $value[0] . $data, $key); + if ($verificationString === $value[2]) { + return $data; + } + } + } + + return false; + } + + /** + * Set HTTP cookie header + * + * This method will construct and set the HTTP `Set-Cookie` header. Slim + * uses this method instead of PHP's native `setcookie` method. This allows + * more control of the HTTP header irrespective of the native implementation's + * dependency on PHP versions. + * + * This method accepts the Slim_Http_Headers object by reference as its + * first argument; this method directly modifies this object instead of + * returning a value. + * + * @param array $header + * @param string $name + * @param string $value + */ + public static function setCookieHeader(&$header, $name, $value) + { + //Build cookie header + if (is_array($value)) { + $domain = ''; + $path = ''; + $expires = ''; + $secure = ''; + $httponly = ''; + if (isset($value['domain']) && $value['domain']) { + $domain = '; domain=' . $value['domain']; + } + if (isset($value['path']) && $value['path']) { + $path = '; path=' . $value['path']; + } + if (isset($value['expires'])) { + if (is_string($value['expires'])) { + $timestamp = strtotime($value['expires']); + } else { + $timestamp = (int) $value['expires']; + } + if ($timestamp !== 0) { + $expires = '; expires=' . gmdate('D, d-M-Y H:i:s e', $timestamp); + } + } + if (isset($value['secure']) && $value['secure']) { + $secure = '; secure'; + } + if (isset($value['httponly']) && $value['httponly']) { + $httponly = '; HttpOnly'; + } + $cookie = sprintf('%s=%s%s', urlencode($name), urlencode((string) $value['value']), $domain . $path . $expires . $secure . $httponly); + } else { + $cookie = sprintf('%s=%s', urlencode($name), urlencode((string) $value)); + } + + //Set cookie header + if (!isset($header['Set-Cookie']) || $header['Set-Cookie'] === '') { + $header['Set-Cookie'] = $cookie; + } else { + $header['Set-Cookie'] = implode("\n", array($header['Set-Cookie'], $cookie)); + } + } + + /** + * Delete HTTP cookie header + * + * This method will construct and set the HTTP `Set-Cookie` header to invalidate + * a client-side HTTP cookie. If a cookie with the same name (and, optionally, domain) + * is already set in the HTTP response, it will also be removed. Slim uses this method + * instead of PHP's native `setcookie` method. This allows more control of the HTTP header + * irrespective of PHP's native implementation's dependency on PHP versions. + * + * This method accepts the Slim_Http_Headers object by reference as its + * first argument; this method directly modifies this object instead of + * returning a value. + * + * @param array $header + * @param string $name + * @param array $value + */ + public static function deleteCookieHeader(&$header, $name, $value = array()) + { + //Remove affected cookies from current response header + $cookiesOld = array(); + $cookiesNew = array(); + if (isset($header['Set-Cookie'])) { + $cookiesOld = explode("\n", $header['Set-Cookie']); + } + foreach ($cookiesOld as $c) { + if (isset($value['domain']) && $value['domain']) { + $regex = sprintf('@%s=.*domain=%s@', urlencode($name), preg_quote($value['domain'])); + } else { + $regex = sprintf('@%s=@', urlencode($name)); + } + if (preg_match($regex, $c) === 0) { + $cookiesNew[] = $c; + } + } + if ($cookiesNew) { + $header['Set-Cookie'] = implode("\n", $cookiesNew); + } else { + unset($header['Set-Cookie']); + } + + //Set invalidating cookie to clear client-side cookie + self::setCookieHeader($header, $name, array_merge(array('value' => '', 'path' => null, 'domain' => null, 'expires' => time() - 100), $value)); + } + + /** + * Parse cookie header + * + * This method will parse the HTTP request's `Cookie` header + * and extract cookies into an associative array. + * + * @param string + * @return array + */ + public static function parseCookieHeader($header) + { + $cookies = array(); + $header = rtrim($header, "\r\n"); + $headerPieces = preg_split('@\s*[;,]\s*@', $header); + foreach ($headerPieces as $c) { + $cParts = explode('=', $c, 2); + if (count($cParts) === 2) { + $key = urldecode($cParts[0]); + $value = urldecode($cParts[1]); + if (!isset($cookies[$key])) { + $cookies[$key] = $value; + } + } + } + + return $cookies; + } + + /** + * Generate a random IV + * + * This method will generate a non-predictable IV for use with + * the cookie encryption + * + * @param int $expires The UNIX timestamp at which this cookie will expire + * @param string $secret The secret key used to hash the cookie value + * @return string Hash + */ + private static function getIv($expires, $secret) + { + $data1 = hash_hmac('sha1', 'a'.$expires.'b', $secret); + $data2 = hash_hmac('sha1', 'z'.$expires.'y', $secret); + + return pack("h*", $data1.$data2); + } +} diff --git a/Slim/Log.php b/Slim/Log.php new file mode 100644 index 0000000..d872e87 --- /dev/null +++ b/Slim/Log.php @@ -0,0 +1,349 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim; + +/** + * Log + * + * This is the primary logger for a Slim application. You may provide + * a Log Writer in conjunction with this Log to write to various output + * destinations (e.g. a file). This class provides this interface: + * + * debug( mixed $object, array $context ) + * info( mixed $object, array $context ) + * notice( mixed $object, array $context ) + * warning( mixed $object, array $context ) + * error( mixed $object, array $context ) + * critical( mixed $object, array $context ) + * alert( mixed $object, array $context ) + * emergency( mixed $object, array $context ) + * log( mixed $level, mixed $object, array $context ) + * + * This class assumes only that your Log Writer has a public `write()` method + * that accepts any object as its one and only argument. The Log Writer + * class may write or send its argument anywhere: a file, STDERR, + * a remote web API, etc. The possibilities are endless. + * + * @package Slim + * @author Josh Lockhart + * @since 1.0.0 + */ +class Log +{ + const EMERGENCY = 1; + const ALERT = 2; + const CRITICAL = 3; + const FATAL = 3; //DEPRECATED replace with CRITICAL + const ERROR = 4; + const WARN = 5; + const NOTICE = 6; + const INFO = 7; + const DEBUG = 8; + + /** + * @var array + */ + protected static $levels = array( + self::EMERGENCY => 'EMERGENCY', + self::ALERT => 'ALERT', + self::CRITICAL => 'CRITICAL', + self::ERROR => 'ERROR', + self::WARN => 'WARNING', + self::NOTICE => 'NOTICE', + self::INFO => 'INFO', + self::DEBUG => 'DEBUG' + ); + + /** + * @var mixed + */ + protected $writer; + + /** + * @var bool + */ + protected $enabled; + + /** + * @var int + */ + protected $level; + + /** + * Constructor + * @param mixed $writer + */ + public function __construct($writer) + { + $this->writer = $writer; + $this->enabled = true; + $this->level = self::DEBUG; + } + + /** + * Is logging enabled? + * @return bool + */ + public function getEnabled() + { + return $this->enabled; + } + + /** + * Enable or disable logging + * @param bool $enabled + */ + public function setEnabled($enabled) + { + if ($enabled) { + $this->enabled = true; + } else { + $this->enabled = false; + } + } + + /** + * Set level + * @param int $level + * @throws \InvalidArgumentException If invalid log level specified + */ + public function setLevel($level) + { + if (!isset(self::$levels[$level])) { + throw new \InvalidArgumentException('Invalid log level'); + } + $this->level = $level; + } + + /** + * Get level + * @return int + */ + public function getLevel() + { + return $this->level; + } + + /** + * Set writer + * @param mixed $writer + */ + public function setWriter($writer) + { + $this->writer = $writer; + } + + /** + * Get writer + * @return mixed + */ + public function getWriter() + { + return $this->writer; + } + + /** + * Is logging enabled? + * @return bool + */ + public function isEnabled() + { + return $this->enabled; + } + + /** + * Log debug message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function debug($object, $context = array()) + { + return $this->log(self::DEBUG, $object, $context); + } + + /** + * Log info message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function info($object, $context = array()) + { + return $this->log(self::INFO, $object, $context); + } + + /** + * Log notice message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function notice($object, $context = array()) + { + return $this->log(self::NOTICE, $object, $context); + } + + /** + * Log warning message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function warning($object, $context = array()) + { + return $this->log(self::WARN, $object, $context); + } + + /** + * DEPRECATED for function warning + * Log warning message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function warn($object, $context = array()) + { + return $this->log(self::WARN, $object, $context); + } + + /** + * Log error message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function error($object, $context = array()) + { + return $this->log(self::ERROR, $object, $context); + } + + /** + * Log critical message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function critical($object, $context = array()) + { + return $this->log(self::CRITICAL, $object, $context); + } + + /** + * DEPRECATED for function critical + * Log fatal message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function fatal($object, $context = array()) + { + return $this->log(self::CRITICAL, $object, $context); + } + + /** + * Log alert message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function alert($object, $context = array()) + { + return $this->log(self::ALERT, $object, $context); + } + + /** + * Log emergency message + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + */ + public function emergency($object, $context = array()) + { + return $this->log(self::EMERGENCY, $object, $context); + } + + /** + * Log message + * @param mixed $level + * @param mixed $object + * @param array $context + * @return mixed|bool What the Logger returns, or false if Logger not set or not enabled + * @throws \InvalidArgumentException If invalid log level + */ + public function log($level, $object, $context = array()) + { + if (!isset(self::$levels[$level])) { + throw new \InvalidArgumentException('Invalid log level supplied to function'); + } else if ($this->enabled && $this->writer && $level <= $this->level) { + $message = (string)$object; + if (count($context) > 0) { + if (isset($context['exception']) && $context['exception'] instanceof \Exception) { + $message .= ' - ' . $context['exception']; + unset($context['exception']); + } + $message = $this->interpolate($message, $context); + } + return $this->writer->write($message, $level); + } else { + return false; + } + } + + /** + * DEPRECATED for function log + * Log message + * @param mixed $object The object to log + * @param int $level The message level + * @return int|bool + */ + protected function write($object, $level) + { + return $this->log($level, $object); + } + + /** + * Interpolate log message + * @param mixed $message The log message + * @param array $context An array of placeholder values + * @return string The processed string + */ + protected function interpolate($message, $context = array()) + { + $replace = array(); + foreach ($context as $key => $value) { + $replace['{' . $key . '}'] = $value; + } + return strtr($message, $replace); + } +} diff --git a/Slim/LogWriter.php b/Slim/LogWriter.php new file mode 100644 index 0000000..5e44e2f --- /dev/null +++ b/Slim/LogWriter.php @@ -0,0 +1,75 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim; + +/** + * Log Writer + * + * This class is used by Slim_Log to write log messages to a valid, writable + * resource handle (e.g. a file or STDERR). + * + * @package Slim + * @author Josh Lockhart + * @since 1.6.0 + */ +class LogWriter +{ + /** + * @var resource + */ + protected $resource; + + /** + * Constructor + * @param resource $resource + * @throws \InvalidArgumentException If invalid resource + */ + public function __construct($resource) + { + if (!is_resource($resource)) { + throw new \InvalidArgumentException('Cannot create LogWriter. Invalid resource handle.'); + } + $this->resource = $resource; + } + + /** + * Write message + * @param mixed $message + * @param int $level + * @return int|bool + */ + public function write($message, $level = null) + { + return fwrite($this->resource, (string) $message . PHP_EOL); + } +} diff --git a/Slim/Middleware.php b/Slim/Middleware.php new file mode 100644 index 0000000..be23100 --- /dev/null +++ b/Slim/Middleware.php @@ -0,0 +1,114 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim; + +/** + * Middleware + * + * @package Slim + * @author Josh Lockhart + * @since 1.6.0 + */ +abstract class Middleware +{ + /** + * @var \Slim\Slim Reference to the primary application instance + */ + protected $app; + + /** + * @var mixed Reference to the next downstream middleware + */ + protected $next; + + /** + * Set application + * + * This method injects the primary Slim application instance into + * this middleware. + * + * @param \Slim\Slim $application + */ + final public function setApplication($application) + { + $this->app = $application; + } + + /** + * Get application + * + * This method retrieves the application previously injected + * into this middleware. + * + * @return \Slim\Slim + */ + final public function getApplication() + { + return $this->app; + } + + /** + * Set next middleware + * + * This method injects the next downstream middleware into + * this middleware so that it may optionally be called + * when appropriate. + * + * @param \Slim|\Slim\Middleware + */ + final public function setNextMiddleware($nextMiddleware) + { + $this->next = $nextMiddleware; + } + + /** + * Get next middleware + * + * This method retrieves the next downstream middleware + * previously injected into this middleware. + * + * @return \Slim\Slim|\Slim\Middleware + */ + final public function getNextMiddleware() + { + return $this->next; + } + + /** + * Call + * + * Perform actions specific to this middleware and optionally + * call the next downstream middleware. + */ + abstract public function call(); +} diff --git a/Slim/Middleware/ContentTypes.php b/Slim/Middleware/ContentTypes.php new file mode 100644 index 0000000..08049db --- /dev/null +++ b/Slim/Middleware/ContentTypes.php @@ -0,0 +1,174 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Middleware; + + /** + * Content Types + * + * This is middleware for a Slim application that intercepts + * the HTTP request body and parses it into the appropriate + * PHP data structure if possible; else it returns the HTTP + * request body unchanged. This is particularly useful + * for preparing the HTTP request body for an XML or JSON API. + * + * @package Slim + * @author Josh Lockhart + * @since 1.6.0 + */ +class ContentTypes extends \Slim\Middleware +{ + /** + * @var array + */ + protected $contentTypes; + + /** + * Constructor + * @param array $settings + */ + public function __construct($settings = array()) + { + $defaults = array( + 'application/json' => array($this, 'parseJson'), + 'application/xml' => array($this, 'parseXml'), + 'text/xml' => array($this, 'parseXml'), + 'text/csv' => array($this, 'parseCsv') + ); + $this->contentTypes = array_merge($defaults, $settings); + } + + /** + * Call + */ + public function call() + { + $mediaType = $this->app->request()->getMediaType(); + if ($mediaType) { + $env = $this->app->environment(); + $env['slim.input_original'] = $env['slim.input']; + $env['slim.input'] = $this->parse($env['slim.input'], $mediaType); + } + $this->next->call(); + } + + /** + * Parse input + * + * This method will attempt to parse the request body + * based on its content type if available. + * + * @param string $input + * @param string $contentType + * @return mixed + */ + protected function parse ($input, $contentType) + { + if (isset($this->contentTypes[$contentType]) && is_callable($this->contentTypes[$contentType])) { + $result = call_user_func($this->contentTypes[$contentType], $input); + if ($result) { + return $result; + } + } + + return $input; + } + + /** + * Parse JSON + * + * This method converts the raw JSON input + * into an associative array. + * + * @param string $input + * @return array|string + */ + protected function parseJson($input) + { + if (function_exists('json_decode')) { + $result = json_decode($input, true); + if ($result) { + return $result; + } + } + } + + /** + * Parse XML + * + * This method creates a SimpleXMLElement + * based upon the XML input. If the SimpleXML + * extension is not available, the raw input + * will be returned unchanged. + * + * @param string $input + * @return \SimpleXMLElement|string + */ + protected function parseXml($input) + { + if (class_exists('SimpleXMLElement')) { + try { + $backup = libxml_disable_entity_loader(true); + $result = new \SimpleXMLElement($input); + libxml_disable_entity_loader($backup); + return $result; + } catch (\Exception $e) { + // Do nothing + } + } + + return $input; + } + + /** + * Parse CSV + * + * This method parses CSV content into a numeric array + * containing an array of data for each CSV line. + * + * @param string $input + * @return array + */ + protected function parseCsv($input) + { + $temp = fopen('php://memory', 'rw'); + fwrite($temp, $input); + fseek($temp, 0); + $res = array(); + while (($data = fgetcsv($temp)) !== false) { + $res[] = $data; + } + fclose($temp); + + return $res; + } +} diff --git a/Slim/Middleware/Flash.php b/Slim/Middleware/Flash.php new file mode 100644 index 0000000..96f685e --- /dev/null +++ b/Slim/Middleware/Flash.php @@ -0,0 +1,212 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Middleware; + + /** + * Flash + * + * This is middleware for a Slim application that enables + * Flash messaging between HTTP requests. This allows you + * set Flash messages for the current request, for the next request, + * or to retain messages from the previous request through to + * the next request. + * + * @package Slim + * @author Josh Lockhart + * @since 1.6.0 + */ +class Flash extends \Slim\Middleware implements \ArrayAccess, \IteratorAggregate, \Countable +{ + /** + * @var array + */ + protected $settings; + + /** + * @var array + */ + protected $messages; + + /** + * Constructor + * @param array $settings + */ + public function __construct($settings = array()) + { + $this->settings = array_merge(array('key' => 'slim.flash'), $settings); + $this->messages = array( + 'prev' => array(), //flash messages from prev request (loaded when middleware called) + 'next' => array(), //flash messages for next request + 'now' => array() //flash messages for current request + ); + } + + /** + * Call + */ + public function call() + { + //Read flash messaging from previous request if available + $this->loadMessages(); + + //Prepare flash messaging for current request + $env = $this->app->environment(); + $env['slim.flash'] = $this; + $this->next->call(); + $this->save(); + } + + /** + * Now + * + * Specify a flash message for a given key to be shown for the current request + * + * @param string $key + * @param string $value + */ + public function now($key, $value) + { + $this->messages['now'][(string) $key] = $value; + } + + /** + * Set + * + * Specify a flash message for a given key to be shown for the next request + * + * @param string $key + * @param string $value + */ + public function set($key, $value) + { + $this->messages['next'][(string) $key] = $value; + } + + /** + * Keep + * + * Retain flash messages from the previous request for the next request + */ + public function keep() + { + foreach ($this->messages['prev'] as $key => $val) { + $this->messages['next'][$key] = $val; + } + } + + /** + * Save + */ + public function save() + { + $_SESSION[$this->settings['key']] = $this->messages['next']; + } + + /** + * Load messages from previous request if available + */ + public function loadMessages() + { + if (isset($_SESSION[$this->settings['key']])) { + $this->messages['prev'] = $_SESSION[$this->settings['key']]; + } + } + + /** + * Return array of flash messages to be shown for the current request + * + * @return array + */ + public function getMessages() + { + return array_merge($this->messages['prev'], $this->messages['now']); + } + + /** + * Array Access: Offset Exists + */ + public function offsetExists($offset) + { + $messages = $this->getMessages(); + + return isset($messages[$offset]); + } + + /** + * Array Access: Offset Get + */ + public function offsetGet($offset) + { + $messages = $this->getMessages(); + + return isset($messages[$offset]) ? $messages[$offset] : null; + } + + /** + * Array Access: Offset Set + */ + public function offsetSet($offset, $value) + { + $this->now($offset, $value); + } + + /** + * Array Access: Offset Unset + */ + public function offsetUnset($offset) + { + unset($this->messages['prev'][$offset], $this->messages['now'][$offset]); + } + + /** + * Iterator Aggregate: Get Iterator + * @return \ArrayIterator + */ + public function getIterator() + { + $messages = $this->getMessages(); + + return new \ArrayIterator($messages); + } + + /** + * Countable: Count + */ + public function count() + { + return count($this->getMessages()); + } + + + +} diff --git a/Slim/Middleware/MethodOverride.php b/Slim/Middleware/MethodOverride.php new file mode 100644 index 0000000..7fa3bb0 --- /dev/null +++ b/Slim/Middleware/MethodOverride.php @@ -0,0 +1,94 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Middleware; + + /** + * HTTP Method Override + * + * This is middleware for a Slim application that allows traditional + * desktop browsers to submit pseudo PUT and DELETE requests by relying + * on a pre-determined request parameter. Without this middleware, + * desktop browsers are only able to submit GET and POST requests. + * + * This middleware is included automatically! + * + * @package Slim + * @author Josh Lockhart + * @since 1.6.0 + */ +class MethodOverride extends \Slim\Middleware +{ + /** + * @var array + */ + protected $settings; + + /** + * Constructor + * @param array $settings + */ + public function __construct($settings = array()) + { + $this->settings = array_merge(array('key' => '_METHOD'), $settings); + } + + /** + * Call + * + * Implements Slim middleware interface. This method is invoked and passed + * an array of environment variables. This middleware inspects the environment + * variables for the HTTP method override parameter; if found, this middleware + * modifies the environment settings so downstream middleware and/or the Slim + * application will treat the request with the desired HTTP method. + * + * @return array[status, header, body] + */ + public function call() + { + $env = $this->app->environment(); + if (isset($env['HTTP_X_HTTP_METHOD_OVERRIDE'])) { + // Header commonly used by Backbone.js and others + $env['slim.method_override.original_method'] = $env['REQUEST_METHOD']; + $env['REQUEST_METHOD'] = strtoupper($env['HTTP_X_HTTP_METHOD_OVERRIDE']); + } elseif (isset($env['REQUEST_METHOD']) && $env['REQUEST_METHOD'] === 'POST') { + // HTML Form Override + $req = new \Slim\Http\Request($env); + $method = $req->post($this->settings['key']); + if ($method) { + $env['slim.method_override.original_method'] = $env['REQUEST_METHOD']; + $env['REQUEST_METHOD'] = strtoupper($method); + } + } + $this->next->call(); + } +} diff --git a/Slim/Middleware/PrettyExceptions.php b/Slim/Middleware/PrettyExceptions.php new file mode 100644 index 0000000..8a56442 --- /dev/null +++ b/Slim/Middleware/PrettyExceptions.php @@ -0,0 +1,116 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim\Middleware; + +/** + * Pretty Exceptions + * + * This middleware catches any Exception thrown by the surrounded + * application and displays a developer-friendly diagnostic screen. + * + * @package Slim + * @author Josh Lockhart + * @since 1.0.0 + */ +class PrettyExceptions extends \Slim\Middleware +{ + /** + * @var array + */ + protected $settings; + + /** + * Constructor + * @param array $settings + */ + public function __construct($settings = array()) + { + $this->settings = $settings; + } + + /** + * Call + */ + public function call() + { + try { + $this->next->call(); + } catch (\Exception $e) { + $log = $this->app->getLog(); // Force Slim to append log to env if not already + $env = $this->app->environment(); + $env['slim.log'] = $log; + $env['slim.log']->error($e); + $this->app->contentType('text/html'); + $this->app->response()->status(500); + $this->app->response()->body($this->renderBody($env, $e)); + } + } + + /** + * Render response body + * @param array $env + * @param \Exception $exception + * @return string + */ + protected function renderBody(&$env, $exception) + { + $title = 'Slim Application Error'; + $code = $exception->getCode(); + $message = $exception->getMessage(); + $file = $exception->getFile(); + $line = $exception->getLine(); + $trace = str_replace(array('#', '\n'), array('
#', '
'), $exception->getTraceAsString());
+ $html = sprintf('%s
', $title); + $html .= 'The application could not run because of the following error:
'; + $html .= 'Details
'; + $html .= sprintf('Type: %s
', get_class($exception));
+ if ($code) {
+ $html .= sprintf('Code: %s
', $code);
+ }
+ if ($message) {
+ $html .= sprintf('Message: %s
', $message);
+ }
+ if ($file) {
+ $html .= sprintf('File: %s
', $file);
+ }
+ if ($line) {
+ $html .= sprintf('Line: %s
', $line);
+ }
+ if ($trace) {
+ $html .= 'Trace
'; + $html .= sprintf('%s', $trace); + } + + return sprintf("
%s
%s", $title, $title, $body); + } + + /** + * Default Not Found handler + */ + protected function defaultNotFound() + { + echo static::generateTemplateMarkup('404 Page Not Found', 'The page you are looking for could not be found. Check the address bar to ensure your URL is spelled correctly. If all else fails, you can visit our home page at the link below.
Visit the Home Page'); + } + + /** + * Default Error handler + */ + protected function defaultError($e) + { + $this->getLog()->error($e); + echo self::generateTemplateMarkup('Error', 'A website error has occurred. The website administrator has been notified of the issue. Sorry for the temporary inconvenience.
'); + } +} diff --git a/Slim/View.php b/Slim/View.php new file mode 100644 index 0000000..1a3973b --- /dev/null +++ b/Slim/View.php @@ -0,0 +1,282 @@ + + * @copyright 2011 Josh Lockhart + * @link http://www.slimframework.com + * @license http://www.slimframework.com/license + * @version 2.4.2 + * @package Slim + * + * MIT LICENSE + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +namespace Slim; + +/** + * View + * + * The view is responsible for rendering a template. The view + * should subclass \Slim\View and implement this interface: + * + * public render(string $template); + * + * This method should render the specified template and return + * the resultant string. + * + * @package Slim + * @author Josh Lockhart + * @since 1.0.0 + */ +class View +{ + /** + * Data available to the view templates + * @var \Slim\Helper\Set + */ + protected $data; + + /** + * Path to templates base directory (without trailing slash) + * @var string + */ + protected $templatesDirectory; + + /** + * Constructor + */ + public function __construct() + { + $this->data = new \Slim\Helper\Set(); + } + + /******************************************************************************** + * Data methods + *******************************************************************************/ + + /** + * Does view data have value with key? + * @param string $key + * @return boolean + */ + public function has($key) + { + return $this->data->has($key); + } + + /** + * Return view data value with key + * @param string $key + * @return mixed + */ + public function get($key) + { + return $this->data->get($key); + } + + /** + * Set view data value with key + * @param string $key + * @param mixed $value + */ + public function set($key, $value) + { + $this->data->set($key, $value); + } + + /** + * Set view data value as Closure with key + * @param string $key + * @param mixed $value + */ + public function keep($key, Closure $value) + { + $this->data->keep($key, $value); + } + + /** + * Return view data + * @return array + */ + public function all() + { + return $this->data->all(); + } + + /** + * Replace view data + * @param array $data + */ + public function replace(array $data) + { + $this->data->replace($data); + } + + /** + * Clear view data + */ + public function clear() + { + $this->data->clear(); + } + + /******************************************************************************** + * Legacy data methods + *******************************************************************************/ + + /** + * DEPRECATION WARNING! This method will be removed in the next major point release + * + * Get data from view + */ + public function getData($key = null) + { + if (!is_null($key)) { + return isset($this->data[$key]) ? $this->data[$key] : null; + } else { + return $this->data->all(); + } + } + + /** + * DEPRECATION WARNING! This method will be removed in the next major point release + * + * Set data for view + */ + public function setData() + { + $args = func_get_args(); + if (count($args) === 1 && is_array($args[0])) { + $this->data->replace($args[0]); + } elseif (count($args) === 2) { + // Ensure original behavior is maintained. DO NOT invoke stored Closures. + if (is_object($args[1]) && method_exists($args[1], '__invoke')) { + $this->data->set($args[0], $this->data->protect($args[1])); + } else { + $this->data->set($args[0], $args[1]); + } + } else { + throw new \InvalidArgumentException('Cannot set View data with provided arguments. Usage: `View::setData( $key, $value );` or `View::setData([ key => value, ... ]);`'); + } + } + + /** + * DEPRECATION WARNING! This method will be removed in the next major point release + * + * Append data to view + * @param array $data + */ + public function appendData($data) + { + if (!is_array($data)) { + throw new \InvalidArgumentException('Cannot append view data. Expected array argument.'); + } + $this->data->replace($data); + } + + /******************************************************************************** + * Resolve template paths + *******************************************************************************/ + + /** + * Set the base directory that contains view templates + * @param string $directory + * @throws \InvalidArgumentException If directory is not a directory + */ + public function setTemplatesDirectory($directory) + { + $this->templatesDirectory = rtrim($directory, DIRECTORY_SEPARATOR); + } + + /** + * Get templates base directory + * @return string + */ + public function getTemplatesDirectory() + { + return $this->templatesDirectory; + } + + /** + * Get fully qualified path to template file using templates base directory + * @param string $file The template file pathname relative to templates base directory + * @return string + */ + public function getTemplatePathname($file) + { + return $this->templatesDirectory . DIRECTORY_SEPARATOR . ltrim($file, DIRECTORY_SEPARATOR); + } + + /******************************************************************************** + * Rendering + *******************************************************************************/ + + /** + * Display template + * + * This method echoes the rendered template to the current output buffer + * + * @param string $template Pathname of template file relative to templates directory + * @param array $data Any additonal data to be passed to the template. + */ + public function display($template, $data = null) + { + echo $this->fetch($template, $data); + } + + /** + * Return the contents of a rendered template file + * + * @param string $template The template pathname, relative to the template base directory + * @param array $data Any additonal data to be passed to the template. + * @return string The rendered template + */ + public function fetch($template, $data = null) + { + return $this->render($template, $data); + } + + /** + * Render a template file + * + * NOTE: This method should be overridden by custom view subclasses + * + * @param string $template The template pathname, relative to the template base directory + * @param array $data Any additonal data to be passed to the template. + * @return string The rendered template + * @throws \RuntimeException If resolved template pathname is not a valid file + */ + protected function render($template, $data = null) + { + $templatePathname = $this->getTemplatePathname($template); + if (!is_file($templatePathname)) { + throw new \RuntimeException("View cannot render `$template` because the template does not exist"); + } + + $data = array_merge($this->data->all(), (array) $data); + extract($data); + ob_start(); + require $templatePathname; + + return ob_get_clean(); + } +} diff --git a/config.inc.php b/config.inc.php new file mode 100644 index 0000000..71061b1 --- /dev/null +++ b/config.inc.php @@ -0,0 +1,14 @@ + \ No newline at end of file diff --git a/image.php b/image.php new file mode 100644 index 0000000..b8563be --- /dev/null +++ b/image.php @@ -0,0 +1,62 @@ +get('/photos/thumbnail/:imageID(/:createImgTag)', function ($imageID, $createImgTag = 0) use ($app, $dirRicetteDropBox) { + $mysqlconnetion = new MysqlClass; + + $retObj = $mysqlconnetion->queryToObject("select type_format, id_ricette from immagini where id=" . $imageID, false); + $mysqlconnetion->disconnetti(); + + + $ext = ""; + if ($retObj["type_format"] == "image/jpeg") { + $ext = "jpg"; + } else if ($retObj["type_format"] == "image/png") { + $ext = "png"; + } + + $folder = $dirRicetteDropBox . "/" . $retObj["id_ricette"]; + + $imageFileName = $imageID . "_thumb_ricetta." . $ext; + + $dropBoxObj = new myDropBox(); + + if ($createImgTag) { + echo 'Could not store token! Make sure that the directory `tokens` exists and is writable!'); + } + + private function load_token($name) { + if (!file_exists("tokens/$name.token")) + return null; + return @unserialize(@file_get_contents("tokens/$name.token")); + } + + private function delete_token($name) { + @unlink("tokens/$name.token"); + } + +} diff --git a/nbproject/private/config.properties b/nbproject/private/config.properties new file mode 100644 index 0000000..e69de29 diff --git a/nbproject/private/private.properties b/nbproject/private/private.properties new file mode 100644 index 0000000..49ccdf8 --- /dev/null +++ b/nbproject/private/private.properties @@ -0,0 +1,9 @@ +browser.id=Chrome.INTEGRATED +copy.src.files=false +copy.src.on.open=false +copy.src.target= +hostname=localhost +port=8888 +router=mdbTester.php +run.as=INTERNAL +url=http://localhost:8888/ diff --git a/nbproject/private/private.xml b/nbproject/private/private.xml new file mode 100644 index 0000000..284eeec --- /dev/null +++ b/nbproject/private/private.xml @@ -0,0 +1,7 @@ + +