File size: 16,548 Bytes
e4f4821 |
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 |
<?php
namespace Kanboard\Model;
use Kanboard\Core\Base;
use Kanboard\Core\Security\Token;
use Kanboard\Core\Security\Role;
use Kanboard\Model\TaskModel;
use Kanboard\Model\TaskFileModel;
/**
* Project model
*
* @package Kanboard\Model
* @author Frederic Guillot
*/
class ProjectModel extends Base
{
/**
* SQL table name for projects
*
* @var string
*/
const TABLE = 'projects';
/**
* Value for active project
*
* @var integer
*/
const ACTIVE = 1;
/**
* Value for inactive project
*
* @var integer
*/
const INACTIVE = 0;
/**
* Value for private project
*
* @var integer
*/
const TYPE_PRIVATE = 1;
/**
* Value for team project
*
* @var integer
*/
const TYPE_TEAM = 0;
/**
* Get a project by the id
*
* @access public
* @param integer $project_id Project id
* @return array
*/
public function getById($project_id)
{
return $this->db->table(self::TABLE)->eq('id', $project_id)->findOne();
}
/**
* Get a project by id with owner name
*
* @access public
* @param integer $project_id Project id
* @return array
*/
public function getByIdWithOwner($project_id)
{
return $this->db->table(self::TABLE)
->columns(self::TABLE.'.*', UserModel::TABLE.'.username AS owner_username', UserModel::TABLE.'.name AS owner_name')
->eq(self::TABLE.'.id', $project_id)
->join(UserModel::TABLE, 'id', 'owner_id')
->findOne();
}
/**
* Get a project by id with owner name and task count
*
* @access public
* @param integer $project_id Project id
* @return array
*/
public function getByIdWithOwnerAndTaskCount($project_id)
{
return $this->db->table(self::TABLE)
->columns(
self::TABLE.'.*',
UserModel::TABLE.'.username AS owner_username',
UserModel::TABLE.'.name AS owner_name',
"(SELECT count(*) FROM tasks WHERE tasks.project_id=projects.id AND tasks.is_active='1') AS nb_active_tasks"
)
->eq(self::TABLE.'.id', $project_id)
->join(UserModel::TABLE, 'id', 'owner_id')
->join(TaskModel::TABLE, 'project_id', 'id')
->findOne();
}
/**
* Get a project by the name
*
* @access public
* @param string $name Project name
* @return array
*/
public function getByName($name)
{
return $this->db->table(self::TABLE)->eq('name', $name)->findOne();
}
/**
* Get a project by the identifier (code)
*
* @access public
* @param string $identifier
* @return array|boolean
*/
public function getByIdentifier($identifier)
{
if (empty($identifier)) {
return false;
}
return $this->db->table(self::TABLE)->eq('identifier', strtoupper($identifier))->findOne();
}
/**
* Get a project by the email address
*
* @access public
* @param string $email
* @return array|boolean
*/
public function getByEmail($email)
{
if (empty($email)) {
return false;
}
return $this->db->table(self::TABLE)->eq('email', $email)->findOne();
}
/**
* Fetch project data by using the token
*
* @access public
* @param string $token Token
* @return array|boolean
*/
public function getByToken($token)
{
if (empty($token)) {
return false;
}
return $this->db->table(self::TABLE)->eq('token', $token)->eq('is_public', 1)->findOne();
}
/**
* Return the first project from the database (no sorting)
*
* @access public
* @return array
*/
public function getFirst()
{
return $this->db->table(self::TABLE)->findOne();
}
/**
* Return true if the project is private
*
* @access public
* @param integer $project_id Project id
* @return boolean
*/
public function isPrivate($project_id)
{
return $this->db->table(self::TABLE)->eq('id', $project_id)->eq('is_private', 1)->exists();
}
/**
* Get all projects
*
* @access public
* @return array
*/
public function getAll()
{
return $this->db->table(self::TABLE)->asc('name')->findAll();
}
/**
* Get all projects with given Ids
*
* @access public
* @param integer[] $project_ids
* @return array
*/
public function getAllByIds(array $project_ids)
{
if (empty($project_ids)) {
return array();
}
return $this->db->table(self::TABLE)->in('id', $project_ids)->asc('name')->findAll();
}
/**
* Get all project ids
*
* @access public
* @return array
*/
public function getAllIds()
{
return $this->db->table(self::TABLE)->asc('name')->findAllByColumn('id');
}
/**
* Return the list of all projects
*
* @access public
* @param bool $prependNone
* @param bool $noPrivateProjects
* @return array
*/
public function getList($prependNone = true, $noPrivateProjects = true)
{
if ($noPrivateProjects) {
$projects = $this->db->hashtable(self::TABLE)->eq('is_private', 0)->asc('name')->getAll('id', 'name');
} else {
$projects = $this->db->hashtable(self::TABLE)->asc('name')->getAll('id', 'name');
}
if ($prependNone) {
return array(t('None')) + $projects;
}
return $projects;
}
/**
* Get all projects with all its data for a given status
*
* @access public
* @param integer $status Project status: self::ACTIVE or self:INACTIVE
* @return array
*/
public function getAllByStatus($status)
{
return $this->db
->table(self::TABLE)
->asc('name')
->eq('is_active', $status)
->findAll();
}
/**
* Get a list of project by status
*
* @access public
* @param integer $status Project status: self::ACTIVE or self:INACTIVE
* @return array
*/
public function getListByStatus($status)
{
return $this->db
->hashtable(self::TABLE)
->asc('name')
->eq('is_active', $status)
->getAll('id', 'name');
}
/**
* Return the number of projects by status
*
* @access public
* @param integer $status Status: self::ACTIVE or self:INACTIVE
* @return integer
*/
public function countByStatus($status)
{
return $this->db
->table(self::TABLE)
->eq('is_active', $status)
->count();
}
/**
* Get stats for each column of a project
*
* @access public
* @param array $project
* @return array
*/
public function getColumnStats(array &$project)
{
$project['columns'] = $this->columnModel->getAllWithTaskCount($project['id']);
$project['nb_active_tasks'] = 0;
foreach ($project['columns'] as $column) {
$project['nb_active_tasks'] += $column['nb_open_tasks'];
}
return $project;
}
/**
* Apply column stats to a collection of projects (filter callback)
*
* @access public
* @param array $projects
* @return array
*/
public function applyColumnStats(array $projects)
{
foreach ($projects as &$project) {
$this->getColumnStats($project);
}
return $projects;
}
/**
* Get project summary for a list of project
*
* @access public
* @param array $project_ids List of project id
* @return \PicoDb\Table
*/
public function getQueryColumnStats(array $project_ids)
{
if (empty($project_ids)) {
return $this->db->table(ProjectModel::TABLE)->eq(ProjectModel::TABLE.'.id', 0);
}
return $this->db
->table(ProjectModel::TABLE)
->columns(self::TABLE.'.*', UserModel::TABLE.'.username AS owner_username', UserModel::TABLE.'.name AS owner_name')
->join(UserModel::TABLE, 'id', 'owner_id')
->in(self::TABLE.'.id', $project_ids)
->callback(array($this, 'applyColumnStats'));
}
/**
* Get query for list of project without column statistics
*
* @access public
* @param array $projectIds
* @return \PicoDb\Table
*/
public function getQueryByProjectIds(array $projectIds)
{
if (empty($projectIds)) {
return $this->db->table(ProjectModel::TABLE)->eq(ProjectModel::TABLE.'.id', 0);
}
return $this->db
->table(ProjectModel::TABLE)
->columns(self::TABLE.'.*', UserModel::TABLE.'.username AS owner_username', UserModel::TABLE.'.name AS owner_name')
->join(UserModel::TABLE, 'id', 'owner_id')
->in(self::TABLE.'.id', $projectIds);
}
/**
* Create a project
*
* @access public
* @param array $values Form values
* @param integer $userId User who create the project
* @param bool $addUser Automatically add the user
* @return int Project id
*/
public function create(array $values, $userId = 0, $addUser = false)
{
if (! empty($userId) && ! $this->userModel->exists($userId)) {
return false;
}
$this->db->startTransaction();
$values['token'] = '';
$values['last_modified'] = time();
$values['is_private'] = empty($values['is_private']) ? 0 : 1;
$values['owner_id'] = $userId;
if (! empty($values['identifier'])) {
$values['identifier'] = strtoupper($values['identifier']);
}
$this->helper->model->convertIntegerFields($values, array('priority_default', 'priority_start', 'priority_end', 'task_limit'));
if (! $this->db->table(self::TABLE)->save($values)) {
$this->db->cancelTransaction();
return false;
}
$project_id = $this->db->getLastId();
if (! $this->boardModel->create($project_id, $this->boardModel->getUserColumns())) {
$this->db->cancelTransaction();
return false;
}
if (! $this->swimlaneModel->create($project_id, t('Default swimlane'))) {
$this->db->cancelTransaction();
return false;
}
if ($addUser && $userId) {
$this->projectUserRoleModel->addUser($project_id, $userId, Role::PROJECT_MANAGER);
}
$this->categoryModel->createDefaultCategories($project_id);
$this->db->closeTransaction();
return (int) $project_id;
}
/**
* Check if the project have been modified
*
* @access public
* @param integer $project_id Project id
* @param integer $timestamp Timestamp
* @return bool
*/
public function isModifiedSince($project_id, $timestamp)
{
return (bool) $this->db->table(self::TABLE)
->eq('id', $project_id)
->gt('last_modified', $timestamp)
->count();
}
/**
* Update modification date
*
* @access public
* @param integer $project_id Project id
* @return bool
*/
public function updateModificationDate($project_id)
{
return $this->db->table(self::TABLE)->eq('id', $project_id)->update(array(
'last_modified' => time()
));
}
/**
* Update a project
*
* @access public
* @param array $values Form values
* @return bool
*/
public function update(array $values)
{
if (! empty($values['identifier'])) {
$values['identifier'] = strtoupper($values['identifier']);
}
if (! empty($values['start_date'])) {
$values['start_date'] = $this->dateParser->getIsoDate($values['start_date']);
}
if (! empty($values['end_date'])) {
$values['end_date'] = $this->dateParser->getIsoDate($values['end_date']);
}
if (! empty($values['owner_id']) && ! $this->userModel->exists($values['owner_id'])) {
return false;
}
$values['per_swimlane_task_limits'] = empty($values['per_swimlane_task_limits']) ? 0 : 1;
$this->helper->model->convertIntegerFields($values, array('priority_default', 'priority_start', 'priority_end', 'task_limit'));
$updates = $values;
unset($updates['id']);
return $this->exists($values['id']) &&
$this->db->table(self::TABLE)->eq('id', $values['id'])->save($updates);
}
/**
* Remove a project
*
* @access public
* @param integer $project_id Project id
* @return bool
*/
public function remove($project_id)
{
// Remove all project attachments
$this->projectFileModel->removeAll($project_id);
// Remove all task attachments
$file_ids = $this->db
->table(TaskFileModel::TABLE)
->eq(TaskModel::TABLE.'.project_id', $project_id)
->join(TaskModel::TABLE, 'id', 'task_id', TaskFileModel::TABLE)
->findAllByColumn(TaskFileModel::TABLE.'.id');
foreach ($file_ids as $file_id) {
$this->taskFileModel->remove($file_id);
}
// Remove project
$this->db->table(TagModel::TABLE)->eq('project_id', $project_id)->remove();
return $this->db->table(self::TABLE)->eq('id', $project_id)->remove();
}
/**
* Return true if the project exists
*
* @access public
* @param integer $project_id Project id
* @return boolean
*/
public function exists($project_id)
{
return $this->db->table(self::TABLE)->eq('id', $project_id)->exists();
}
/**
* Enable a project
*
* @access public
* @param integer $project_id Project id
* @return bool
*/
public function enable($project_id)
{
return $this->exists($project_id) &&
$this->db
->table(self::TABLE)
->eq('id', $project_id)
->update(array('is_active' => 1));
}
/**
* Disable a project
*
* @access public
* @param integer $project_id Project id
* @return bool
*/
public function disable($project_id)
{
return $this->exists($project_id) &&
$this->db
->table(self::TABLE)
->eq('id', $project_id)
->update(array('is_active' => 0));
}
/**
* Enable public access for a project
*
* @access public
* @param integer $project_id Project id
* @return bool
*/
public function enablePublicAccess($project_id)
{
return $this->exists($project_id) &&
$this->db
->table(self::TABLE)
->eq('id', $project_id)
->save(array('is_public' => 1, 'token' => Token::getToken()));
}
/**
* Disable public access for a project
*
* @access public
* @param integer $project_id Project id
* @return bool
*/
public function disablePublicAccess($project_id)
{
return $this->exists($project_id) &&
$this->db
->table(self::TABLE)
->eq('id', $project_id)
->save(array('is_public' => 0, 'token' => ''));
}
/**
* Change usage of global tags
*
* @param integer $project_id Project id
* @param bool $global_tags New global tag value
* @return bool
*/
public function changeGlobalTagUsage($project_id, $global_tags)
{
return $this->exists($project_id) &&
$this->db
->table(self::TABLE)
->eq('id', $project_id)
->save(array('enable_global_tags' => $global_tags));
}
}
|