Root/
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 | <?php/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- *//*# ***** BEGIN LICENSE BLOCK *****# This file is part of InDefero, an open source project management application.# Copyright (C) 2008 Céondo Ltd and contributors.## InDefero is free software; you can redistribute it and/or modify# it under the terms of the GNU General Public License as published by# the Free Software Foundation; either version 2 of the License, or# (at your option) any later version.## InDefero is distributed in the hope that it will be useful,# but WITHOUT ANY WARRANTY; without even the implied warranty of# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the# GNU General Public License for more details.## You should have received a copy of the GNU General Public License# along with this program; if not, write to the Free Software# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA## ***** END LICENSE BLOCK ***** *//** * Base definition of a project. * * The issue management system can be used to manage several projects * at the same time. */class IDF_Project extends Pluf_Model{ public $_model = __CLASS__; public $_extra_cache = array(); protected $_pconf = null; /** * Check if the project as one restricted tab. * * This is the cached information. * * @see self::isRestricted */ protected $_isRestricted = null; function init() { $this->_pconf = null; $this->_extra_cache = array(); $this->_a['table'] = 'idf_projects'; $this->_a['model'] = __CLASS__; $this->_a['cols'] = array( // It is mandatory to have an "id" column. 'id' => array( 'type' => 'Pluf_DB_Field_Sequence', 'blank' => true, ), 'name' => array( 'type' => 'Pluf_DB_Field_Varchar', 'blank' => false, 'size' => 250, 'verbose' => __('name'), ), 'shortname' => array( 'type' => 'Pluf_DB_Field_Varchar', 'blank' => false, 'size' => 50, 'verbose' => __('short name'), 'help_text' => __('Used in the url to access the project, must be short with only letters and numbers.'), 'unique' => true, ), 'shortdesc' => array( 'type' => 'Pluf_DB_Field_Varchar', 'blank' => false, 'size' => 255, 'verbose' => __('short description'), 'help_text' => __('A one line description of the project.'), ), 'description' => array( 'type' => 'Pluf_DB_Field_Text', 'blank' => false, 'size' => 250, 'verbose' => __('description'), 'help_text' => __('The description can be extended using the markdown syntax.'), ), 'private' => array( 'type' => 'Pluf_DB_Field_Integer', 'blank' => false, 'verbose' => __('private'), 'default' => 0, ), ); } /** * String representation of the abstract. */ function __toString() { return $this->name; } /** * String ready for indexation. */ function _toIndex() { return ''; } function preSave($create=false) { if ($this->id == '') { $this->creation_dtime = gmdate('Y-m-d H:i:s'); } $this->modif_dtime = gmdate('Y-m-d H:i:s'); } public static function getOr404($shortname) { $sql = new Pluf_SQL('shortname=%s', array(trim($shortname))); $projects = Pluf::factory(__CLASS__)->getList(array('filter' => $sql->gen())); if ($projects->count() != 1) { throw new Pluf_HTTP_Error404(sprintf(__('Project "%s" not found.'), $shortname)); } return $projects[0]; } /** * Returns the number of open/closed issues. * * @param string Status ('open'), 'closed' * @param IDF_Tag Subfilter with a label (null) * @return int Count */ public function getIssueCountByStatus($status='open', $label=null) { switch ($status) { case 'open': $key = 'labels_issue_open'; $default = IDF_Form_IssueTrackingConf::init_open; break; case 'closed': default: $key = 'labels_issue_closed'; $default = IDF_Form_IssueTrackingConf::init_closed; break; } $tags = array(); foreach ($this->getTagsFromConfig($key, $default, 'Status') as $tag) { $tags[] = (int)$tag->id; } if (count($tags) == 0) return array(); $sql = new Pluf_SQL(sprintf('project=%%s AND status IN (%s)', implode(', ', $tags)), array($this->id)); if (!is_null($label)) { $sql2 = new Pluf_SQL('idf_tag_id=%s', array($label->id)); $sql->SAnd($sql2); } $params = array('filter' => $sql->gen()); if (!is_null($label)) { $params['view'] = 'join_tags'; } $gissue = new IDF_Issue(); return $gissue->getCount($params); } /** * Get the open/closed tag ids as they are often used when doing * listings. * * As this can be often used, the info are cached. * * @param string Status ('open') or 'closed' * @param bool Force cache refresh (false) * @return array Ids of the open/closed tags */ public function getTagIdsByStatus($status='open', $cache_refresh=false) { if (!$cache_refresh and isset($this->_extra_cache['getTagIdsByStatus-'.$status])) { return $this->_extra_cache['getTagIdsByStatus-'.$status]; } switch ($status) { case 'open': $key = 'labels_issue_open'; $default = IDF_Form_IssueTrackingConf::init_open; break; case 'closed': default: $key = 'labels_issue_closed'; $default = IDF_Form_IssueTrackingConf::init_closed; break; } $tags = array(); foreach ($this->getTagsFromConfig($key, $default, 'Status') as $tag) { $tags[] = (int) $tag->id; } $this->_extra_cache['getTagIdsByStatus-'.$status] = $tags; return $tags; } /** * Convert the definition of tags in the configuration into the * corresponding list of tags. * * @param string Configuration key where the tag is. * @param string Default config if nothing in the db. * @param string Default class. * @return array List of tags */ public function getTagsFromConfig($cfg_key, $default, $dclass='Other') { $conf = $this->getConf(); $tags = array(); foreach (preg_split("/\015\012|\015|\012/", $conf->getVal($cfg_key, $default), -1, PREG_SPLIT_NO_EMPTY) as $s) { $_s = explode('=', $s, 2); $v = trim($_s[0]); $_v = explode(':', $v, 2); if (count($_v) > 1) { $class = trim($_v[0]); $name = trim($_v[1]); } else { $name = trim($_s[0]); $class = $dclass; } $tags[] = IDF_Tag::add($name, $this, $class); } return $tags; } /** * Return membership data. * * The array has 3 keys: 'members', 'owners' and 'authorized'. * * The list of users is only taken using the row level permission * table. That is, if you set a user as administrator, he will * have the member and owner rights but will not appear in the * lists. * * @param string Format ('objects'), 'string'. * @return mixed Array of Pluf_User or newline separated list of logins. */ public function getMembershipData($fmt='objects') { $mperm = Pluf_Permission::getFromString('IDF.project-member'); $operm = Pluf_Permission::getFromString('IDF.project-owner'); $aperm = Pluf_Permission::getFromString('IDF.project-authorized-user'); $grow = new Pluf_RowPermission(); $db =& Pluf::db(); $false = Pluf_DB_BooleanToDb(false, $db); $sql = new Pluf_SQL('model_class=%s AND model_id=%s AND owner_class=%s AND permission=%s AND negative='.$false, array('IDF_Project', $this->id, 'Pluf_User', $operm->id)); $owners = new Pluf_Template_ContextVars(array()); foreach ($grow->getList(array('filter' => $sql->gen())) as $row) { if ($fmt == 'objects') { $owners[] = Pluf::factory('Pluf_User', $row->owner_id); } else { $owners[] = Pluf::factory('Pluf_User', $row->owner_id)->login; } } $sql = new Pluf_SQL('model_class=%s AND model_id=%s AND owner_class=%s AND permission=%s AND negative='.$false, array('IDF_Project', $this->id, 'Pluf_User', $mperm->id)); $members = new Pluf_Template_ContextVars(array()); foreach ($grow->getList(array('filter' => $sql->gen())) as $row) { if ($fmt == 'objects') { $members[] = Pluf::factory('Pluf_User', $row->owner_id); } else { $members[] = Pluf::factory('Pluf_User', $row->owner_id)->login; } } $authorized = new Pluf_Template_ContextVars(array()); if ($aperm != false) { $sql = new Pluf_SQL('model_class=%s AND model_id=%s AND owner_class=%s AND permission=%s AND negative='.$false, array('IDF_Project', $this->id, 'Pluf_User', $aperm->id)); foreach ($grow->getList(array('filter' => $sql->gen())) as $row) { if ($fmt == 'objects') { $authorized[] = Pluf::factory('Pluf_User', $row->owner_id); } else { $authorized[] = Pluf::factory('Pluf_User', $row->owner_id)->login; } } } if ($fmt == 'objects') { return new Pluf_Template_ContextVars(array('members' => $members, 'owners' => $owners, 'authorized' => $authorized)); } else { return array('members' => implode("\n", (array) $members), 'owners' => implode("\n", (array) $owners), 'authorized' => implode("\n", (array) $authorized), ); } } /** * Generate the tag clouds. * * Return an array of tags sorted by class, then name. Each tag * get the extra property 'nb_use' for the number of use in the * project. * * @param string ('issues') 'closed_issues', 'wiki' or 'downloads' * @return ArrayObject of IDF_Tag */ public function getTagCloud($what='issues') { $tag_t = Pluf::factory('IDF_Tag')->getSqlTable(); if ($what == 'issues' or $what == 'closed_issues') { $what_t = Pluf::factory('IDF_Issue')->getSqlTable(); $asso_t = $this->_con->pfx.'idf_issue_idf_tag_assoc'; if ($what == 'issues') { $ostatus = $this->getTagIdsByStatus('open'); } else { $ostatus = $this->getTagIdsByStatus('closed'); } if (count($ostatus) == 0) $ostatus[] = 0; $sql = sprintf('SELECT '.$tag_t.'.id AS id, COUNT(*) AS nb_use FROM '.$tag_t.' '."\n". 'LEFT JOIN '.$asso_t.' ON idf_tag_id='.$tag_t.'.id '."\n". 'LEFT JOIN '.$what_t.' ON idf_issue_id='.$what_t.'.id '."\n". 'WHERE idf_tag_id IS NOT NULL AND '.$what_t.'.status IN (%s) AND '.$what_t.'.project='.$this->id.' GROUP BY '.$tag_t.'.id, '.$tag_t.'.class, '.$tag_t.'.name ORDER BY '.$tag_t.'.class ASC, '.$tag_t.'.name ASC', implode(', ', $ostatus)); } elseif ($what == 'wiki') { $dep_ids = IDF_Views_Wiki::getDeprecatedPagesIds($this); $extra = ''; if (count($dep_ids)) { $extra = ' AND idf_wikipage_id NOT IN ('.implode(', ', $dep_ids).') '; } $what_t = Pluf::factory('IDF_WikiPage')->getSqlTable(); $asso_t = $this->_con->pfx.'idf_tag_idf_wikipage_assoc'; $sql = 'SELECT '.$tag_t.'.id AS id, COUNT(*) AS nb_use FROM '.$tag_t.' '."\n". 'LEFT JOIN '.$asso_t.' ON idf_tag_id='.$tag_t.'.id '."\n". 'LEFT JOIN '.$what_t.' ON idf_wikipage_id='.$what_t.'.id '."\n". 'WHERE idf_tag_id IS NOT NULL '.$extra.' AND '.$what_t.'.project='.$this->id.' GROUP BY '.$tag_t.'.id, '.$tag_t.'.class, '.$tag_t.'.name ORDER BY '.$tag_t.'.class ASC, '.$tag_t.'.name ASC'; } elseif ($what == 'downloads') { $dep_ids = IDF_Views_Download::getDeprecatedFilesIds($this); $extra = ''; if (count($dep_ids)) { $extra = ' AND idf_upload_id NOT IN ('.implode(', ', $dep_ids).') '; } $what_t = Pluf::factory('IDF_Upload')->getSqlTable(); $asso_t = $this->_con->pfx.'idf_tag_idf_upload_assoc'; $sql = 'SELECT '.$tag_t.'.id AS id, COUNT(*) AS nb_use FROM '.$tag_t.' '."\n". 'LEFT JOIN '.$asso_t.' ON idf_tag_id='.$tag_t.'.id '."\n". 'LEFT JOIN '.$what_t.' ON idf_upload_id='.$what_t.'.id '."\n". 'WHERE idf_tag_id IS NOT NULL '.$extra.' AND '.$what_t.'.project='.$this->id.' GROUP BY '.$tag_t.'.id, '.$tag_t.'.class, '.$tag_t.'.name ORDER BY '.$tag_t.'.class ASC, '.$tag_t.'.name ASC'; } $tags = array(); foreach ($this->_con->select($sql) as $idc) { $tag = new IDF_Tag($idc['id']); $tag->nb_use = $idc['nb_use']; $tags[] = $tag; } return new Pluf_Template_ContextVars($tags); } /** * Get the repository size. * * @param bool Force to skip the cache (false) * @return int Size in byte or -1 if not available */ public function getRepositorySize($force=false) { $last_eval = $this->getConf()->getVal('repository_size_check_date', 0); if (Pluf::f('idf_no_size_check', false) or (!$force and $last_eval > time()-172800)) { return $this->getConf()->getVal('repository_size', -1); } $this->getConf()->setVal('repository_size_check_date', time()); $scm = IDF_Scm::get($this); $this->getConf()->setVal('repository_size', $scm->getRepositorySize()); return $this->getConf()->getVal('repository_size', -1); } /** * Get the access url to the repository. * * This will return the right url based on the user. * * @param Pluf_User The user (null) * @param string A specific commit to access */ public function getSourceAccessUrl($user=null, $commit=null) { $right = $this->getConf()->getVal('source_access_rights', 'all'); if (($user == null or $user->isAnonymous()) and $right == 'all' and !$this->private) { return $this->getRemoteAccessUrl($commit); } return $this->getWriteRemoteAccessUrl($user, $commit); } /** * Get the remote access url to the repository. * * This will always return the anonymous access url. * * @param string A specific commit to access */ public function getRemoteAccessUrl($commit=null) { $conf = $this->getConf(); $scm = $conf->getVal('scm', 'git'); $scms = Pluf::f('allowed_scm'); Pluf::loadClass($scms[$scm]); return call_user_func(array($scms[$scm], 'getAnonymousAccessUrl'), $this, $commit); } /** * Get the remote write access url to the repository. * * Some SCM have a remote access URL to write which is not the * same as the one to read. For example, you do a checkout with * git-daemon and push with SSH. * * @param string A specific commit to access */ public function getWriteRemoteAccessUrl($user,$commit=null) { $conf = $this->getConf(); $scm = $conf->getVal('scm', 'git'); $scms = Pluf::f('allowed_scm'); return call_user_func(array($scms[$scm], 'getAuthAccessUrl'), $this, $user, $commit); } /** * Get the post commit hook key. * * The goal is to get something predictable but from which one * cannot reverse find the secret key. */ public function getPostCommitHookKey() { return md5($this->id.sha1(Pluf::f('secret_key')).$this->shortname); } /** * Get the root name of the project scm * * @return string SCM root */ public function getScmRoot() { $conf = $this->getConf(); $roots = array( 'git' => 'master', 'svn' => 'HEAD', 'mercurial' => 'tip', 'mtn' => 'h:'.$conf->getVal('mtn_master_branch', '*'), ); $scm = $conf->getVal('scm', 'git'); return $roots[$scm]; } /** * Check that the object belongs to the project or rise a 404 * error. * * By convention, all the objects belonging to a project have the * 'project' property set, so this is easy to check. * * @param Pluf_Model */ public function inOr404($obj) { if ($obj->project != $this->id) { throw new Pluf_HTTP_Error404(); } } /** * Utility function to get a configuration object. * * @return IDF_Conf */ public function getConf() { if ($this->_pconf == null) { $this->_pconf = new IDF_Conf(); $this->_pconf->setProject($this); } return $this->_pconf; } /** * Get simple statistics about the project. * * This returns an associative array with number of tickets, * number of downloads, etc. * * @return array Stats */ public function getStats() { $stats = array(); $stats['total'] = 0; $what = array('downloads' => 'IDF_Upload', 'reviews' => 'IDF_Review', 'issues' => 'IDF_Issue', 'docpages' => 'IDF_WikiPage', 'commits' => 'IDF_Commit', ); foreach ($what as $key=>$m) { $i = Pluf::factory($m)->getCount(array('filter' => 'project='.(int)$this->id)); $stats[$key] = $i; $stats['total'] += $i; } /** * [signal] * * IDF_Project::getStats * * [sender] * * IDF_Project * * [description] * * This signal allows an application to update the statistics * array of a project. For example to add the on disk size * of the repository if available. * * [parameters] * * array('project' => $project, * 'stats' => $stats) * */ $params = array('project' => $this, 'stats' => $stats); Pluf_Signal::send('IDF_Project::getStats', 'IDF_Project', $params); return $stats; } /** * Needs to be called when you update the memberships of a * project. * * This will allow a plugin to, for example, update some access * rights to a repository. */ public function membershipsUpdated() { /** * [signal] * * IDF_Project::membershipsUpdated * * [sender] * * IDF_Project * * [description] * * This signal allows an application to update the some access * rights to a repository when the project memberships is * updated. * * [parameters] * * array('project' => $project) * */ $params = array('project' => $this); Pluf_Signal::send('IDF_Project::membershipsUpdated', 'IDF_Project', $params); } /** * Needs to be called when you create a project. * * We cannot put it into the postSave call as the configuration of * the project is not defined at that time. */ function created() { /** * [signal] * * IDF_Project::created * * [sender] * * IDF_Project * * [description] * * This signal allows an application to perform special * operations at the creation of a project. * * [parameters] * * array('project' => $project) * */ $params = array('project' => $this); Pluf_Signal::send('IDF_Project::created', 'IDF_Project', $params); } /** * The delete() call do not like circular references and the * IDF_Tag is creating some. We predelete to solve these issues. */ public function preDelete() { /** * [signal] * * IDF_Project::preDelete * * [sender] * * IDF_Project * * [description] * * This signal allows an application to perform special * operations at the deletion of a project. * * [parameters] * * array('project' => $project) * */ $params = array('project' => $this); Pluf_Signal::send('IDF_Project::preDelete', 'IDF_Project', $params); $what = array('IDF_Upload', 'IDF_Review', 'IDF_Issue', 'IDF_WikiPage', 'IDF_Commit', 'IDF_Tag', ); foreach ($what as $m) { foreach (Pluf::factory($m)->getList(array('filter' => 'project='.(int)$this->id)) as $item) { $item->delete(); } } } /** * Check if the project has one restricted tab. * * @return bool */ public function isRestricted() { if ($this->_isRestricted !== null) { return $this->_isRestricted; } if ($this->private) { $this->_isRestricted = true; return true; } $tabs = array( 'source_access_rights', 'issues_access_rights', 'downloads_access_rights', 'wiki_access_rights', 'review_access_rights' ); $conf = $this->getConf(); foreach ($tabs as $tab) { if (!in_array($conf->getVal($tab, 'all'), array('all', 'none'))) { $this->_isRestricted = true; return true; } } $this->_isRestricted = false; return false; }} |
