Repos.php 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. <?php
  2. namespace Gogs\API\Request {
  3. /**
  4. * Repos is a collection of repos.
  5. *
  6. * @author Joachim M. Giaever (joachim[]giaever.org)
  7. * @version 0.1.2
  8. */
  9. final class Repos extends Collection {
  10. const SORT_UPDATED = Collection::SORT_INDEX << 1;
  11. const SORT_CREATED = Collection::SORT_INDEX << 2;
  12. const SORT_OWNER = Collection::SORT_INDEX << 3;
  13. protected $owner;
  14. /**
  15. * Initialize a repos collection
  16. *
  17. * If owner is not set it will query the whole
  18. * repo archive on Gogs.
  19. *
  20. * @param string $api_url The api-url
  21. * @param string $api_token The api-token
  22. * @param User $owner The owner of the collection
  23. */
  24. public function __construct(string $api_url, string $api_token, User $owner = null) {
  25. parent::__construct($api_url, $api_token);
  26. $this->owner = $owner;
  27. }
  28. /**
  29. * @see Base
  30. */
  31. protected function set_scope(string $method) {
  32. switch ($method) {
  33. case "get":
  34. case "load":
  35. if ($this->owner instanceof Org)
  36. $this->scope = "/orgs/" . $this->owner->username . "/repos";
  37. else
  38. $this->scope = ($this->owner == null || $this->owner->authenticated() ? "/user" : "/users/" . $this->owner->username ) . "/repos";
  39. break;
  40. case "search":
  41. $this->scope = "/repos/search";
  42. break;
  43. default:
  44. return false;
  45. }
  46. return true;
  47. }
  48. /**
  49. * Get a single repository by name.
  50. *
  51. * If the `owner` is set, the name can be just the
  52. * actual name of the repo
  53. *
  54. * @param string $name
  55. * @return
  56. */
  57. public function get(string $name) {
  58. if (isset($this->owner) && strpos($name, "/") === false )
  59. $name = sprintf("%s/%s", $this->owner->username, $name);
  60. if ($repo = $this->by_key($name))
  61. return $repo;
  62. $owner = !empty($this->owner) ? $this->owner : (
  63. ($pos = strpos($name, "/")) !== false ?
  64. new User($this->url, $this->token, substr($name, 0, $pos)) : null
  65. );
  66. $repo = (new Repo(
  67. $this->url,
  68. $this->token,
  69. $owner,
  70. ($pos = strpos($name, "/")) ? substr($name, $pos + 1) : $name
  71. ))->load();
  72. $this->add($repo, $repo->full_name);
  73. return $repo;
  74. }
  75. /**
  76. * @see Collection
  77. */
  78. public function create(...$args) {
  79. $repo = new Repo($this->url, $this->token, $this->owner);
  80. if (count($args) > 0) {
  81. $repo->create(...$args);
  82. $this->add($repo, $repo->full_name);
  83. }
  84. return $repo;
  85. }
  86. /**
  87. * Searches for a repo.
  88. *
  89. * If the owner is specified the search will be
  90. * limited to the actual user.
  91. *
  92. * @see Collection
  93. * @return Repos
  94. */
  95. public function search(array $params = array()) {
  96. if (!isset($params["name"]) && !isset($params["q"]))
  97. throw new Exception\SearchParamException("Missing param <name>|<q>");
  98. if (isset($params["name"])) {
  99. $params["q"] = $params["name"];
  100. unset($params["name"]);
  101. }
  102. if (!isset($params["user"]) || isset($this->owner))
  103. $params["user"] = isset($this->owner) ? $this->owner->id : 0;
  104. if (!isset($params["limit"]))
  105. $params["limit"] = 10;
  106. $repos = new Repos($this->url, $this->token, $this->owner);
  107. if ($this->loaded) {
  108. foreach($this->all() as $key => $repo) {
  109. if ($repo->search($params["q"]))
  110. $repos->add($repo, $key);
  111. if ($repos->len() == $params["limit"])
  112. break;
  113. }
  114. } else {
  115. $this->set_scope("search");
  116. $jenc = $this->method_get($params);
  117. $jdec = $this->json_decode($jenc);
  118. foreach($this->json_set_property($jdec) as $key)
  119. $repos->add($this->by_key($key), $key);
  120. }
  121. return $repos;
  122. }
  123. /**
  124. * Sort repos by `method`.
  125. *
  126. * Valid methods:
  127. *
  128. * * SORT_UPDATED: Sort on `updated_at` value
  129. * * SORT_CREATED: Sort on `created_at` value
  130. * * SORT_OWNER: Sort on `owner` (organization repos etc may appear)
  131. *
  132. * @param int $flag Defines sorting algorithm to use
  133. * @param bool $asc Ascending order
  134. * @return \Gogs\Lib\Collection
  135. */
  136. public function sort_by(int $flag = Collection::SORT_INDEX, bool $asc = false) {
  137. switch ($flag) {
  138. case self::SORT_CREATED:
  139. return ($sort = $this->sort(function(Repo $a, Repo $b) {
  140. $adate = new \DateTime($a->created_at);
  141. $bdate = new \DateTime($b->created_at);
  142. return ($adate == $bdate ? 0 : ($adate > $bdate ? 1 : -1));
  143. })) ? ($asc ? $sort->reverse() : $sort) : false;
  144. case self::SORT_UPDATED:
  145. return ($sort = $this->sort(function(Repo $a, Repo $b) {
  146. $adate = new \DateTime($a->updated_at);
  147. $bdate = new \DateTime($b->updated_at);
  148. return ($adate == $bdate ? 0 : ($adate > $bdate ? 1 : -1));
  149. })) ? ($asc ? $sort->reverse() : $sort) : false;
  150. case self::SORT_OWNER:
  151. return ($sort = $this->sort(function(Repo $a, Repo $b) {
  152. return strcmp($a->owner->username, $b->owner->username);
  153. })) ? ($asc ? $sort->reverse() : $sort) : false;
  154. default:
  155. return ($sort = $this->sort("ksort")) ? ($asc ? $sort->reverse() : $sort) : false;
  156. }
  157. }
  158. /**
  159. * @see Base
  160. */
  161. protected function json_set_property($obj) {
  162. if (isset($obj->data))
  163. return $this->json_set_property($obj->data);
  164. $rnames = array();
  165. if (is_array($obj)) {
  166. foreach ($obj as $key => $val) {
  167. $repo = new Repo($this->url, $this->token);
  168. $repo->json_set_property($val);
  169. $this->add($repo, $repo->full_name);
  170. $rnames[] = $repo->full_name;
  171. }
  172. }
  173. return $rnames;
  174. }
  175. }
  176. }