Bootstrap.php 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996
  1. <?php declare(strict_types=1);
  2. use Google\Cloud\Core\Exception\BadRequestException;
  3. use Google\Cloud\Core\Exception\NotFoundException;
  4. use Google\Cloud\Storage\Bucket;
  5. use Google\Cloud\Storage\Connection\ConnectionInterface;
  6. use Google\Cloud\Storage\StorageClient;
  7. use Google\Cloud\Storage\StorageObject;
  8. use PrivateBin\Persistence\ServerSalt;
  9. error_reporting(E_ALL | E_STRICT);
  10. // change this, if your php files and data is outside of your webservers document root
  11. if (!defined('PUBLIC_PATH')) {
  12. define('PUBLIC_PATH', '..');
  13. }
  14. if (!defined('PATH')) {
  15. define('PATH', '..' . DIRECTORY_SEPARATOR);
  16. }
  17. if (!defined('CONF')) {
  18. define('CONF', PATH . 'cfg' . DIRECTORY_SEPARATOR . 'conf.php');
  19. }
  20. if (!defined('CONF_SAMPLE')) {
  21. define('CONF_SAMPLE', PATH . 'cfg' . DIRECTORY_SEPARATOR . 'conf.sample.php');
  22. }
  23. require PATH . 'vendor/autoload.php';
  24. Helper::updateSubresourceIntegrity();
  25. /**
  26. * Class Helper provides unit tests pastes and comments of various formats
  27. */
  28. class Helper
  29. {
  30. /**
  31. * example ID of a paste
  32. *
  33. * @var string
  34. */
  35. private static $pasteid = '5b65a01b43987bc2';
  36. /**
  37. * example paste version 1
  38. *
  39. * @var array
  40. */
  41. private static $pasteV1 = array(
  42. 'data' => '{"iv":"EN39/wd5Nk8HAiSG2K5AsQ","v":1,"iter":1000,"ks":128,"ts":64,"mode":"ccm","adata":"","cipher":"aes","salt":"QKN1DBXe5PI","ct":"8hA83xDdXjD7K2qfmw5NdA"}',
  43. 'attachment' => '{"iv":"Pd4pOKWkmDTT9uPwVwd5Ag","v":1,"iter":1000,"ks":128,"ts":64,"mode":"ccm","adata":"","cipher":"aes","salt":"ZIUhFTliVz4","ct":"6nOCU3peNDclDDpFtJEBKA"}',
  44. 'attachmentname' => '{"iv":"76MkAtOGC4oFogX/aSMxRA","v":1,"iter":1000,"ks":128,"ts":64,"mode":"ccm","adata":"","cipher":"aes","salt":"ZIUhFTliVz4","ct":"b6Ae/U1xJdsX/+lATud4sQ"}',
  45. 'meta' => array(
  46. 'formatter' => 'plaintext',
  47. 'postdate' => 1344803344,
  48. 'opendiscussion' => true,
  49. ),
  50. );
  51. /**
  52. * example paste version 2
  53. *
  54. * @var array
  55. */
  56. private static $pasteV2 = array(
  57. 'adata' => array(
  58. array(
  59. 'gMSNoLOk4z0RnmsYwXZ8mw==',
  60. 'TZO+JWuIuxs=',
  61. 100000,
  62. 256,
  63. 128,
  64. 'aes',
  65. 'gcm',
  66. 'zlib',
  67. ),
  68. 'plaintext',
  69. 1,
  70. 0,
  71. ),
  72. 'meta' => array(
  73. 'expire' => '5min',
  74. ),
  75. 'v' => 2,
  76. 'ct' => 'ME5JF/YBEijp2uYMzLZozbKtWc5wfy6R59NBb7SmRig=',
  77. );
  78. /**
  79. * example ID of a comment
  80. *
  81. * @var string
  82. */
  83. private static $commentid = '5a52eebf11c4c94b';
  84. /**
  85. * example comment
  86. *
  87. * @var array
  88. */
  89. private static $commentV1 = array(
  90. 'data' => '{"iv":"Pd4pOKWkmDTT9uPwVwd5Ag","v":1,"iter":1000,"ks":128,"ts":64,"mode":"ccm","adata":"","cipher":"aes","salt":"ZIUhFTliVz4","ct":"6nOCU3peNDclDDpFtJEBKA"}',
  91. 'meta' => array(
  92. 'nickname' => '{"iv":"76MkAtOGC4oFogX/aSMxRA","v":1,"iter":1000,"ks":128,"ts":64,"mode":"ccm","adata":"","cipher":"aes","salt":"ZIUhFTliVz4","ct":"b6Ae/U1xJdsX/+lATud4sQ"}',
  93. 'vizhash' => 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABGUlEQVQokWOsl5/94983CNKQMjnxaOePf98MeKwPfNjkLZ3AgARab6b9+PeNEVnDj3/ff/z7ZiHnzsDA8Pv7H2TVPJw8EAYLAwb48OaVgIgYKycLsrYv378wMDB8//qdCVMDRA9EKSsnCwRBxNsepaLboMFlyMDAICAi9uHNK24GITQ/MDAwoNhgIGMLtwGrzegaLjw5jMz9+vUdnN17uwDCQDhJgk0O07yvX9+teDX1x79v6DYIsIjgcgMaYGFgYOBg4kJx2JejkAiBxAw+PzAwMNz4dp6wDXDw4MdNNOl0rWYsNkD89OLXI/xmo9sgzatJjAYmBgYGDiauD3/ePP18nVgb4MF89+M5ZX6js293wUMpnr8KTQMAxsCJnJ30apMAAAAASUVORK5CYII=',
  94. 'postdate' => 1344803528,
  95. ),
  96. );
  97. /**
  98. * JS files and their SRI hashes
  99. *
  100. * @var array
  101. */
  102. private static $hashes = array();
  103. /**
  104. * get example paste ID
  105. *
  106. * @return string
  107. */
  108. public static function getPasteId()
  109. {
  110. return self::$pasteid;
  111. }
  112. /**
  113. * get example paste, as stored on server
  114. *
  115. * @param int $version
  116. * @param array $meta
  117. * @return array
  118. */
  119. public static function getPaste($version = 2, array $meta = array())
  120. {
  121. $example = self::getPasteWithAttachment($version, $meta);
  122. // v1 has the attachment stored in a separate property
  123. if ($version === 1) {
  124. unset($example['attachment'], $example['attachmentname']);
  125. }
  126. return $example;
  127. }
  128. /**
  129. * get example paste with attachment, as stored on server
  130. *
  131. * @param int $version
  132. * @param array $meta
  133. * @return array
  134. */
  135. public static function getPasteWithAttachment($version = 2, array $meta = array())
  136. {
  137. $example = $version === 1 ? self::$pasteV1 : self::$pasteV2;
  138. $example['meta']['salt'] = ServerSalt::generate();
  139. $example['meta'] = array_merge($example['meta'], $meta);
  140. return $example;
  141. }
  142. /**
  143. * get example paste, as decoded from POST by the request object
  144. *
  145. * @param int $version
  146. * @param array $meta
  147. * @return array
  148. */
  149. public static function getPastePost($version = 2, array $meta = array())
  150. {
  151. $example = self::getPaste($version, $meta);
  152. if ($version == 2) {
  153. $example['meta'] = array('expire' => $example['meta']['expire']);
  154. } else {
  155. unset($example['meta']['postdate']);
  156. }
  157. return $example;
  158. }
  159. /**
  160. * get example paste, as received via POST by the user
  161. *
  162. * @param int $version
  163. * @param array $meta
  164. * @return array
  165. */
  166. public static function getPasteJson($version = 2, array $meta = array())
  167. {
  168. return json_encode(self::getPastePost($version, $meta));
  169. }
  170. /**
  171. * get example paste ID
  172. *
  173. * @return string
  174. */
  175. public static function getCommentId()
  176. {
  177. return self::$commentid;
  178. }
  179. /**
  180. * get example comment, as stored on server
  181. *
  182. * @param int $version
  183. * @param array $meta
  184. * @return array
  185. */
  186. public static function getComment($version = 2, array $meta = array())
  187. {
  188. $example = $version === 1 ? self::$commentV1 : self::$pasteV2;
  189. if ($version === 2) {
  190. $example['adata'] = $example['adata'][0];
  191. $example['pasteid'] = $example['parentid'] = self::getPasteId();
  192. $example['meta']['created'] = self::$commentV1['meta']['postdate'];
  193. $example['meta']['icon'] = self::$commentV1['meta']['vizhash'];
  194. unset($example['meta']['expire']);
  195. }
  196. $example['meta'] = array_merge($example['meta'], $meta);
  197. return $example;
  198. }
  199. /**
  200. * get example comment, as decoded from POST by the request object
  201. *
  202. * @param int $version
  203. * @return array
  204. */
  205. public static function getCommentPost()
  206. {
  207. $example = self::getComment();
  208. unset($example['meta']);
  209. return $example;
  210. }
  211. /**
  212. * get example comment, as received via POST by user
  213. *
  214. * @param int $version
  215. * @return array
  216. */
  217. public static function getCommentJson()
  218. {
  219. return json_encode(self::getCommentPost());
  220. }
  221. /**
  222. * Returns 16 random hexadecimal characters.
  223. *
  224. * @return string
  225. */
  226. public static function getRandomId()
  227. {
  228. // 8 binary bytes are 16 characters long in hex
  229. return bin2hex(random_bytes(8));
  230. }
  231. /**
  232. * delete directory and all its contents recursively
  233. *
  234. * @param string $path
  235. * @throws Exception
  236. */
  237. public static function rmDir($path)
  238. {
  239. if (is_dir($path)) {
  240. $path .= DIRECTORY_SEPARATOR;
  241. $dir = dir($path);
  242. while (false !== ($file = $dir->read())) {
  243. if ($file != '.' && $file != '..') {
  244. if (is_dir($path . $file)) {
  245. self::rmDir($path . $file);
  246. } elseif (is_file($path . $file)) {
  247. if (!unlink($path . $file)) {
  248. throw new Exception('Error deleting file "' . $path . $file . '".');
  249. }
  250. }
  251. }
  252. }
  253. $dir->close();
  254. if (!rmdir($path)) {
  255. throw new Exception('Error deleting directory "' . $path . '".');
  256. }
  257. }
  258. }
  259. /**
  260. * create a backup of the config file
  261. *
  262. * @return void
  263. */
  264. public static function confBackup()
  265. {
  266. if (!is_file(CONF . '.bak') && is_file(CONF)) {
  267. rename(CONF, CONF . '.bak');
  268. }
  269. if (!is_file(CONF_SAMPLE . '.bak') && is_file(CONF_SAMPLE)) {
  270. copy(CONF_SAMPLE, CONF_SAMPLE . '.bak');
  271. }
  272. }
  273. /**
  274. * restor backup of the config file
  275. *
  276. * @return void
  277. */
  278. public static function confRestore()
  279. {
  280. if (is_file(CONF . '.bak')) {
  281. rename(CONF . '.bak', CONF);
  282. }
  283. if (is_file(CONF_SAMPLE . '.bak')) {
  284. rename(CONF_SAMPLE . '.bak', CONF_SAMPLE);
  285. }
  286. }
  287. /**
  288. * create ini file
  289. *
  290. * @param string $pathToFile
  291. * @param array $values
  292. */
  293. public static function createIniFile($pathToFile, array $values)
  294. {
  295. if (count($values)) {
  296. @unlink($pathToFile);
  297. $ini = fopen($pathToFile, 'a');
  298. foreach ($values as $section => $options) {
  299. fwrite($ini, "[$section]" . PHP_EOL);
  300. foreach ($options as $option => $setting) {
  301. if (is_null($setting)) {
  302. continue;
  303. } elseif (is_string($setting)) {
  304. $setting = '"' . $setting . '"';
  305. } elseif (is_array($setting)) {
  306. foreach ($setting as $key => $value) {
  307. if (is_null($value)) {
  308. $value = 'null';
  309. } elseif (is_string($value)) {
  310. $value = '"' . $value . '"';
  311. } else {
  312. $value = var_export($value, true);
  313. }
  314. fwrite($ini, $option . "[$key] = $value" . PHP_EOL);
  315. }
  316. continue;
  317. } else {
  318. $setting = var_export($setting, true);
  319. }
  320. fwrite($ini, "$option = $setting" . PHP_EOL);
  321. }
  322. fwrite($ini, PHP_EOL);
  323. }
  324. fclose($ini);
  325. }
  326. }
  327. /**
  328. * a var_export that returns arrays without line breaks
  329. * by linus@flowingcreativity.net via php.net
  330. *
  331. * @param mixed $var
  332. * @param bool $return
  333. * @return void|string
  334. */
  335. public static function varExportMin($var, $return = false)
  336. {
  337. if (is_array($var)) {
  338. $toImplode = array();
  339. foreach ($var as $key => $value) {
  340. $toImplode[] = var_export($key, true) . ' => ' . self::varExportMin($value, true);
  341. }
  342. $code = 'array(' . implode(', ', $toImplode) . ')';
  343. if ($return) {
  344. return $code;
  345. } else {
  346. echo $code;
  347. }
  348. } else {
  349. return var_export($var, $return);
  350. }
  351. }
  352. /**
  353. * update all templates with the latest SRI hashes for all JS files
  354. *
  355. * @return void
  356. */
  357. public static function updateSubresourceIntegrity()
  358. {
  359. foreach (new GlobIterator(PATH . 'js' . DIRECTORY_SEPARATOR . '*.js') as $file) {
  360. if ($file->getBasename() == 'common.js') {
  361. continue; // ignore JS unit test bootstrap
  362. }
  363. self::$hashes[$file->getBasename()] = base64_encode(
  364. hash('sha512', file_get_contents($file->getPathname()), true)
  365. );
  366. }
  367. $counter = 0;
  368. $file = PATH . 'lib' . DIRECTORY_SEPARATOR . 'Configuration.php';
  369. $content = preg_replace_callback(
  370. '#\'js/([a-z0-9.-]+.js)(\' +)=\> \'[^\']*\',#',
  371. function ($matches) use (&$counter) {
  372. if (array_key_exists($matches[1], Helper::$hashes)) {
  373. ++$counter;
  374. return '\'js/' . $matches[1] . $matches[2] .
  375. '=> \'sha512-' . Helper::$hashes[$matches[1]] . '\',';
  376. } else {
  377. throw new Exception('SRI hash for file js/' . $matches[1] . ' not found, please add the missing file or remove it from lib/Configuration.php.');
  378. }
  379. },
  380. file_get_contents($file)
  381. );
  382. file_put_contents($file, $content);
  383. if ($counter != count(self::$hashes)) {
  384. throw new Exception('Mismatch between ' . count(self::$hashes) . ' found js files and ' . $counter . ' SRI hashes in lib/Configuration.php, please update lib/Configuration.php to match the list of js files.');
  385. }
  386. }
  387. }
  388. /**
  389. * Class BucketStub stubs a GCS bucket.
  390. */
  391. class BucketStub extends Bucket
  392. {
  393. public $_objects;
  394. private $_name;
  395. private $_info;
  396. private $_connection;
  397. private $_client;
  398. public function __construct(ConnectionInterface $connection, $name, array $info = array(), $client = null)
  399. {
  400. $this->_name = $name;
  401. $this->_info = $info;
  402. $this->_connection = $connection;
  403. $this->_objects = array();
  404. $this->_client = $client;
  405. }
  406. public function acl()
  407. {
  408. throw new BadMethodCallException('not supported by this stub');
  409. }
  410. public function defaultAcl()
  411. {
  412. throw new BadMethodCallException('not supported by this stub');
  413. }
  414. public function exists(array $options = array())
  415. {
  416. return true;
  417. }
  418. public function upload($data, array $options = array())
  419. {
  420. if (!is_string($data) || !key_exists('name', $options)) {
  421. throw new BadMethodCallException('not supported by this stub');
  422. }
  423. $name = $options['name'];
  424. $generation = '1';
  425. $o = new StorageObjectStub($this->_connection, $name, $this, $generation, $options);
  426. $this->_objects[$options['name']] = $o;
  427. $o->setData($data);
  428. }
  429. public function uploadAsync($data, array $options = array())
  430. {
  431. throw new BadMethodCallException('not supported by this stub');
  432. }
  433. public function getResumableUploader($data, array $options = array())
  434. {
  435. throw new BadMethodCallException('not supported by this stub');
  436. }
  437. public function getStreamableUploader($data, array $options = array())
  438. {
  439. throw new BadMethodCallException('not supported by this stub');
  440. }
  441. public function object($name, array $options = array())
  442. {
  443. if (key_exists($name, $this->_objects)) {
  444. return $this->_objects[$name];
  445. } else {
  446. return new StorageObjectStub($this->_connection, $name, $this, null, $options);
  447. }
  448. }
  449. public function objects(array $options = array())
  450. {
  451. $prefix = key_exists('prefix', $options) ? $options['prefix'] : '';
  452. return new CallbackFilterIterator(
  453. new ArrayIterator($this->_objects),
  454. function ($current, $key, $iterator) use ($prefix) {
  455. return substr($key, 0, strlen($prefix)) == $prefix;
  456. }
  457. );
  458. }
  459. public function createNotification($topic, array $options = array())
  460. {
  461. throw new BadMethodCallException('not supported by this stub');
  462. }
  463. public function notification($id)
  464. {
  465. throw new BadMethodCallException('not supported by this stub');
  466. }
  467. public function notifications(array $options = array())
  468. {
  469. throw new BadMethodCallException('not supported by this stub');
  470. }
  471. public function delete(array $options = array())
  472. {
  473. $this->_client->deleteBucket($this->_name);
  474. }
  475. public function update(array $options = array())
  476. {
  477. throw new BadMethodCallException('not supported by this stub');
  478. }
  479. public function compose(array $sourceObjects, $name, array $options = array())
  480. {
  481. throw new BadMethodCallException('not supported by this stub');
  482. }
  483. public function info(array $options = array())
  484. {
  485. throw new BadMethodCallException('not supported by this stub');
  486. }
  487. public function reload(array $options = array())
  488. {
  489. throw new BadMethodCallException('not supported by this stub');
  490. }
  491. public function name()
  492. {
  493. return $this->_name;
  494. }
  495. public static function lifecycle(array $lifecycle = array())
  496. {
  497. throw new BadMethodCallException('not supported by this stub');
  498. }
  499. public function currentLifecycle(array $options = array())
  500. {
  501. throw new BadMethodCallException('not supported by this stub');
  502. }
  503. public function isWritable($file = null)
  504. {
  505. throw new BadMethodCallException('not supported by this stub');
  506. }
  507. public function iam()
  508. {
  509. throw new BadMethodCallException('not supported by this stub');
  510. }
  511. public function lockRetentionPolicy(array $options = array())
  512. {
  513. throw new BadMethodCallException('not supported by this stub');
  514. }
  515. public function signedUrl($expires, array $options = array())
  516. {
  517. throw new BadMethodCallException('not supported by this stub');
  518. }
  519. public function generateSignedPostPolicyV4($objectName, $expires, array $options = array())
  520. {
  521. throw new BadMethodCallException('not supported by this stub');
  522. }
  523. }
  524. /**
  525. * Class StorageObjectStub stubs a GCS storage object.
  526. */
  527. class StorageObjectStub extends StorageObject
  528. {
  529. private $_name;
  530. private $_data;
  531. private $_info;
  532. private $_bucket;
  533. private $_generation;
  534. private $_exists = false;
  535. private $_connection;
  536. public function __construct(ConnectionInterface $connection, $name, $bucket, $generation = null, array $info = array(), $encryptionKey = null, $encryptionKeySHA256 = null)
  537. {
  538. $this->_name = $name;
  539. $this->_bucket = $bucket;
  540. $this->_generation = $generation;
  541. $this->_info = $info;
  542. $this->_connection = $connection;
  543. $timeCreated = new DateTime();
  544. $this->_info['metadata']['timeCreated'] = $timeCreated->format('Y-m-d\TH:i:s.u\Z');
  545. }
  546. public function acl()
  547. {
  548. throw new BadMethodCallException('not supported by this stub');
  549. }
  550. public function exists(array $options = array())
  551. {
  552. return key_exists($this->_name, $this->_bucket->_objects);
  553. }
  554. /**
  555. * @throws NotFoundException
  556. */
  557. public function delete(array $options = array())
  558. {
  559. if (key_exists($this->_name, $this->_bucket->_objects)) {
  560. unset($this->_bucket->_objects[$this->_name]);
  561. } else {
  562. throw new NotFoundException('key ' . $this->_name . ' not found.');
  563. }
  564. }
  565. /**
  566. * @throws NotFoundException
  567. */
  568. public function update(array $metadata, array $options = array())
  569. {
  570. if (!$this->_exists) {
  571. throw new NotFoundException('key ' . $this->_name . ' not found.');
  572. }
  573. $this->_info = $metadata;
  574. }
  575. public function copy($destination, array $options = array())
  576. {
  577. throw new BadMethodCallException('not supported by this stub');
  578. }
  579. public function rewrite($destination, array $options = array())
  580. {
  581. throw new BadMethodCallException('not supported by this stub');
  582. }
  583. public function rename($name, array $options = array())
  584. {
  585. throw new BadMethodCallException('not supported by this stub');
  586. }
  587. /**
  588. * @throws NotFoundException
  589. */
  590. public function downloadAsString(array $options = array())
  591. {
  592. if (!$this->_exists) {
  593. throw new NotFoundException('key ' . $this->_name . ' not found.');
  594. }
  595. return $this->_data;
  596. }
  597. public function downloadToFile($path, array $options = array())
  598. {
  599. throw new BadMethodCallException('not supported by this stub');
  600. }
  601. public function downloadAsStream(array $options = array())
  602. {
  603. throw new BadMethodCallException('not supported by this stub');
  604. }
  605. public function downloadAsStreamAsync(array $options = array())
  606. {
  607. throw new BadMethodCallException('not supported by this stub');
  608. }
  609. public function signedUrl($expires, array $options = array())
  610. {
  611. throw new BadMethodCallException('not supported by this stub');
  612. }
  613. public function signedUploadUrl($expires, array $options = array())
  614. {
  615. throw new BadMethodCallException('not supported by this stub');
  616. }
  617. public function beginSignedUploadSession(array $options = array())
  618. {
  619. throw new BadMethodCallException('not supported by this stub');
  620. }
  621. public function info(array $options = array())
  622. {
  623. return key_exists('metadata',$this->_info) ? $this->_info['metadata'] : array();
  624. }
  625. public function reload(array $options = array())
  626. {
  627. throw new BadMethodCallException('not supported by this stub');
  628. }
  629. public function name()
  630. {
  631. return $this->_name;
  632. }
  633. public function identity()
  634. {
  635. throw new BadMethodCallException('not supported by this stub');
  636. }
  637. public function gcsUri()
  638. {
  639. return sprintf(
  640. 'gs://%s/%s',
  641. $this->_bucket->name(),
  642. $this->_name
  643. );
  644. }
  645. public function setData($data)
  646. {
  647. $this->_data = $data;
  648. $this->_exists = true;
  649. }
  650. }
  651. /**
  652. * Class ConnectionInterfaceStub required for the stubs.
  653. */
  654. class ConnectionInterfaceStub implements ConnectionInterface
  655. {
  656. public function deleteAcl(array $args = array())
  657. {
  658. throw new BadMethodCallException('not supported by this stub');
  659. }
  660. public function getAcl(array $args = array())
  661. {
  662. throw new BadMethodCallException('not supported by this stub');
  663. }
  664. public function listAcl(array $args = array())
  665. {
  666. throw new BadMethodCallException('not supported by this stub');
  667. }
  668. public function insertAcl(array $args = array())
  669. {
  670. throw new BadMethodCallException('not supported by this stub');
  671. }
  672. public function patchAcl(array $args = array())
  673. {
  674. throw new BadMethodCallException('not supported by this stub');
  675. }
  676. public function deleteBucket(array $args = array())
  677. {
  678. throw new BadMethodCallException('not supported by this stub');
  679. }
  680. public function getBucket(array $args = array())
  681. {
  682. throw new BadMethodCallException('not supported by this stub');
  683. }
  684. public function listBuckets(array $args = array())
  685. {
  686. throw new BadMethodCallException('not supported by this stub');
  687. }
  688. public function insertBucket(array $args = array())
  689. {
  690. throw new BadMethodCallException('not supported by this stub');
  691. }
  692. public function getBucketIamPolicy(array $args)
  693. {
  694. throw new BadMethodCallException('not supported by this stub');
  695. }
  696. public function setBucketIamPolicy(array $args)
  697. {
  698. throw new BadMethodCallException('not supported by this stub');
  699. }
  700. public function testBucketIamPermissions(array $args)
  701. {
  702. throw new BadMethodCallException('not supported by this stub');
  703. }
  704. public function patchBucket(array $args = array())
  705. {
  706. throw new BadMethodCallException('not supported by this stub');
  707. }
  708. public function deleteObject(array $args = array())
  709. {
  710. throw new BadMethodCallException('not supported by this stub');
  711. }
  712. public function restoreObject(array $args = array())
  713. {
  714. throw new BadMethodCallException('not supported by this stub');
  715. }
  716. public function copyObject(array $args = array())
  717. {
  718. throw new BadMethodCallException('not supported by this stub');
  719. }
  720. public function rewriteObject(array $args = array())
  721. {
  722. throw new BadMethodCallException('not supported by this stub');
  723. }
  724. public function composeObject(array $args = array())
  725. {
  726. throw new BadMethodCallException('not supported by this stub');
  727. }
  728. public function getObject(array $args = array())
  729. {
  730. throw new BadMethodCallException('not supported by this stub');
  731. }
  732. public function listObjects(array $args = array())
  733. {
  734. throw new BadMethodCallException('not supported by this stub');
  735. }
  736. public function patchObject(array $args = array())
  737. {
  738. throw new BadMethodCallException('not supported by this stub');
  739. }
  740. public function downloadObject(array $args = array())
  741. {
  742. throw new BadMethodCallException('not supported by this stub');
  743. }
  744. public function insertObject(array $args = array())
  745. {
  746. throw new BadMethodCallException('not supported by this stub');
  747. }
  748. public function getNotification(array $args = array())
  749. {
  750. throw new BadMethodCallException('not supported by this stub');
  751. }
  752. public function deleteNotification(array $args = array())
  753. {
  754. throw new BadMethodCallException('not supported by this stub');
  755. }
  756. public function insertNotification(array $args = array())
  757. {
  758. throw new BadMethodCallException('not supported by this stub');
  759. }
  760. public function listNotifications(array $args = array())
  761. {
  762. throw new BadMethodCallException('not supported by this stub');
  763. }
  764. public function getServiceAccount(array $args = array())
  765. {
  766. throw new BadMethodCallException('not supported by this stub');
  767. }
  768. public function lockRetentionPolicy(array $args = array())
  769. {
  770. throw new BadMethodCallException('not supported by this stub');
  771. }
  772. public function createHmacKey(array $args = array())
  773. {
  774. throw new BadMethodCallException('not supported by this stub');
  775. }
  776. public function deleteHmacKey(array $args = array())
  777. {
  778. throw new BadMethodCallException('not supported by this stub');
  779. }
  780. public function getHmacKey(array $args = array())
  781. {
  782. throw new BadMethodCallException('not supported by this stub');
  783. }
  784. public function updateHmacKey(array $args = array())
  785. {
  786. throw new BadMethodCallException('not supported by this stub');
  787. }
  788. public function listHmacKeys(array $args = array())
  789. {
  790. throw new BadMethodCallException('not supported by this stub');
  791. }
  792. }
  793. /**
  794. * Class StorageClientStub provides a limited stub for performing the unit test
  795. */
  796. class StorageClientStub extends StorageClient
  797. {
  798. private $_config = null;
  799. private $_connection = null;
  800. private static $_buckets = array();
  801. public function __construct(array $config = array())
  802. {
  803. $this->_config = $config;
  804. $this->_connection = new ConnectionInterfaceStub();
  805. }
  806. public function bucket($name, $userProject = false)
  807. {
  808. if (!key_exists($name, self::$_buckets)) {
  809. $b = new BucketStub($this->_connection, $name, array(), $this);
  810. self::$_buckets[$name] = $b;
  811. }
  812. return self::$_buckets[$name];
  813. }
  814. /**
  815. * @throws \Google\Cloud\Core\Exception\NotFoundException
  816. */
  817. public function deleteBucket($name)
  818. {
  819. if (key_exists($name, self::$_buckets)) {
  820. unset(self::$_buckets[$name]);
  821. } else {
  822. throw new NotFoundException();
  823. }
  824. }
  825. public function buckets(array $options = array())
  826. {
  827. throw new BadMethodCallException('not supported by this stub');
  828. }
  829. public function registerStreamWrapper($protocol = null)
  830. {
  831. throw new BadMethodCallException('not supported by this stub');
  832. }
  833. public function unregisterStreamWrapper($protocol = null)
  834. {
  835. throw new BadMethodCallException('not supported by this stub');
  836. }
  837. public function signedUrlUploader($uri, $data, array $options = array())
  838. {
  839. throw new BadMethodCallException('not supported by this stub');
  840. }
  841. public function timestamp(\DateTimeInterface $timestamp, $nanoSeconds = null)
  842. {
  843. throw new BadMethodCallException('not supported by this stub');
  844. }
  845. public function getServiceAccount(array $options = array())
  846. {
  847. throw new BadMethodCallException('not supported by this stub');
  848. }
  849. public function hmacKeys(array $options = array())
  850. {
  851. throw new BadMethodCallException('not supported by this stub');
  852. }
  853. public function hmacKey($accessId, $projectId = null, array $metadata = array())
  854. {
  855. throw new BadMethodCallException('not supported by this stub');
  856. }
  857. public function createHmacKey($serviceAccountEmail, array $options = array())
  858. {
  859. throw new BadMethodCallException('not supported by this stub');
  860. }
  861. public function createBucket($name, array $options = array())
  862. {
  863. if (key_exists($name, self::$_buckets)) {
  864. throw new BadRequestException('already exists');
  865. }
  866. $b = new BucketStub($this->_connection, $name, array(), $this);
  867. self::$_buckets[$name] = $b;
  868. return $b;
  869. }
  870. }