546 lines
19 KiB
PHP
546 lines
19 KiB
PHP
<?php
|
|
/**
|
|
* The model file of mr module of ZenTaoPMS.
|
|
*
|
|
* @copyright Copyright 2009-2021 青岛易软天创网络科技有限公司(QingDao Nature Easy Soft Network Technology Co,LTD, www.cnezsoft.com)
|
|
* @license ZPL (http://zpl.pub/page/zplv12.html)
|
|
* @author dingguodong <dingguodong@easycorp.ltd>
|
|
* @package mr
|
|
* @version $Id$
|
|
* @link http://www.zentao.net
|
|
*/
|
|
class mrModel extends model
|
|
{
|
|
/**
|
|
* The construct method, to do some auto things.
|
|
*
|
|
* @access public
|
|
* @return void
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->loadModel('gitlab');
|
|
}
|
|
|
|
/**
|
|
* Get a MR by id.
|
|
*
|
|
* @param int $id
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function getByID($id)
|
|
{
|
|
return $this->dao->findByID($id)->from(TABLE_MR)->fetch();
|
|
}
|
|
|
|
/**
|
|
* Get MR list of gitlab project.
|
|
*
|
|
* @param string $orderBy
|
|
* @param object $pager
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function getList($orderBy = 'id_desc', $pager = null)
|
|
{
|
|
$MRList = $this->dao->select('*')
|
|
->from(TABLE_MR)
|
|
->where('deleted')->eq('0')
|
|
->orderBy($orderBy)
|
|
->page($pager)
|
|
->fetchAll('id');
|
|
|
|
return $MRList;
|
|
}
|
|
|
|
/**
|
|
* Get gitlab pairs.
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function getPairs($repoID)
|
|
{
|
|
$MR = $this->dao->select('id,title')
|
|
->from(TABLE_MR)
|
|
->where('deleted')->eq('0')
|
|
->andWhere('repoID')->eq($repoID)
|
|
->orderBy('id')->fetchPairs('id', 'title');
|
|
return array('' => '') + $MR;
|
|
}
|
|
|
|
/**
|
|
* Create MR function.
|
|
*
|
|
* @access public
|
|
* @return int|bool|object
|
|
*/
|
|
public function create()
|
|
{
|
|
$MR = fixer::input('post')
|
|
->add('createdBy', $this->app->user->account)
|
|
->add('createdDate', helper::now())
|
|
->get();
|
|
|
|
$this->dao->insert(TABLE_MR)->data($MR, $this->config->mr->create->skippedFields)
|
|
->batchCheck($this->config->mr->create->requiredFields, 'notempty')
|
|
->autoCheck()
|
|
->exec();
|
|
if(dao::isError()) return array('result' => 'fail', 'message' => dao::getError());
|
|
|
|
$MRID = $this->dao->lastInsertId();
|
|
|
|
$MRObject = new stdclass;
|
|
$MRObject->target_project_id = $MR->targetProject;
|
|
$MRObject->source_branch = $MR->sourceBranch;
|
|
$MRObject->target_branch = $MR->targetBranch;
|
|
$MRObject->title = $MR->title;
|
|
$MRObject->description = $MR->description;
|
|
$MRObject->assignee_ids = $MR->assignee;
|
|
|
|
$rawMR = $this->apiCreateMR($this->post->gitlabID, $this->post->sourceProject, $MRObject);
|
|
|
|
/**
|
|
* Another open merge request already exists for this source branch.
|
|
* The type of variable `$rawMR->message` is array.
|
|
*/
|
|
if(isset($rawMR->message) and !isset($rawMR->iid))
|
|
{
|
|
$this->dao->delete()->from(TABLE_MR)->where('id')->eq($MRID)->exec();
|
|
return array('result' => 'fail', 'message' => sprintf($this->lang->mr->apiError->createMR, $rawMR->message[0]));
|
|
}
|
|
|
|
/* Create MR failed. */
|
|
if(!isset($rawMR->iid))
|
|
{
|
|
$this->dao->delete()->from(TABLE_MR)->where('id')->eq($MRID)->exec();
|
|
return array('result' => 'fail', 'message' => $this->lang->mr->createFailedFromAPI);
|
|
}
|
|
|
|
/* Create a todo item for this MR. */
|
|
$this->apiCreateMRTodo($this->post->gitlabID, $this->post->targetProject, $rawMR->iid);
|
|
|
|
$newMR = new stdclass;
|
|
$newMR->mriid = $rawMR->iid;
|
|
$newMR->status = $rawMR->state;
|
|
$newMR->mergeStatus = $rawMR->merge_status;
|
|
|
|
/* Change gitlab user ID to zentao account. */
|
|
$gitlabUsers = $this->gitlab->getUserIdAccountPairs($MR->gitlabID);
|
|
$newMR->assignee = zget($gitlabUsers, $MR->assignee, '');
|
|
|
|
/* Update MR in Zentao database. */
|
|
$this->dao->update(TABLE_MR)->data($newMR)
|
|
->where('id')->eq($MRID)
|
|
->autoCheck()
|
|
->exec();
|
|
if(dao::isError()) return array('result' => 'fail', 'message' => dao::getError());
|
|
return array('result' => 'success', 'message' => $this->lang->saveSuccess, 'locate' => helper::createLink('mr', 'browse'));
|
|
}
|
|
|
|
/**
|
|
* Edit MR function.
|
|
*
|
|
* @access public
|
|
* @return void
|
|
*/
|
|
public function update($MRID)
|
|
{
|
|
$MR = fixer::input('post')
|
|
->setDefault('editedBy', $this->app->user->account)
|
|
->setDefault('editedDate', helper::now())
|
|
->get();
|
|
|
|
/* Update MR in GitLab. */
|
|
$newMR = new stdclass;
|
|
$newMR->title = $MR->title;
|
|
$newMR->description = $MR->description;
|
|
$newMR->assignee_ids = $MR->assignee;
|
|
$newMR->target_branch = $MR->targetBranch;
|
|
|
|
$oldMR = $this->getByID($MRID);
|
|
|
|
/* Known issue: `reviewer_ids` takes no effect. */
|
|
$rawMR = $this->apiUpdateMR($oldMR->gitlabID, $oldMR->targetProject, $oldMR->mriid, $newMR);
|
|
|
|
/* Change gitlab user ID to zentao account. */
|
|
$gitlabUsers = $this->gitlab->getUserIdAccountPairs($oldMR->gitlabID);
|
|
$MR->assignee = zget($gitlabUsers, $MR->assignee, '');
|
|
|
|
/* Update MR in Zentao database. */
|
|
$this->dao->update(TABLE_MR)->data($MR)
|
|
->where('id')->eq($MRID)
|
|
->batchCheck($this->config->mr->edit->requiredFields, 'notempty')
|
|
->autoCheck()
|
|
->exec();
|
|
$MR = $this->getByID($MRID);
|
|
|
|
if(dao::isError()) return array('result' => 'fail', 'message' => dao::getError());
|
|
return array('result' => 'success', 'message' => $this->lang->saveSuccess, 'locate' => helper::createLink('mr', 'browse'));
|
|
}
|
|
|
|
/**
|
|
* sync MR from GitLab API to Zentao database.
|
|
*
|
|
* @param object $MR
|
|
* @access public
|
|
* @return void
|
|
*/
|
|
public function apiSyncMR($MR)
|
|
{
|
|
$rawMR = $this->apiGetSingleMR($MR->gitlabID, $MR->targetProject, $MR->mriid);
|
|
/* Sync MR in ZenTao database whatever status of MR in GitLab. */
|
|
if(isset($rawMR->iid))
|
|
{
|
|
$map = $this->config->mr->maps->sync;
|
|
$gitlabUsers = $this->gitlab->getUserIdAccountPairs($MR->gitlabID);
|
|
|
|
$newMR = new stdclass;
|
|
foreach($map as $syncField => $config)
|
|
{
|
|
$value = '';
|
|
list($field, $optionType, $options) = explode('|', $config);
|
|
|
|
if($optionType == 'field') $value = $rawMR->$field;
|
|
if($optionType == 'userPairs')
|
|
{
|
|
$gitlabUserID = '';
|
|
if(isset($rawMR->$field[0]))
|
|
{
|
|
$gitlabUserID = $rawMR->$field[0]->$options;
|
|
}
|
|
$value = zget($gitlabUsers, $gitlabUserID, '');
|
|
}
|
|
|
|
if($value) $newMR->$syncField = $value;
|
|
}
|
|
|
|
/* Update MR in Zentao database. */
|
|
$this->dao->update(TABLE_MR)->data($newMR)
|
|
->where('id')->eq($MR->id)
|
|
->exec();
|
|
}
|
|
return $this->dao->findByID($MR->id)->from(TABLE_MR)->fetch();
|
|
}
|
|
|
|
/**
|
|
* Batch Sync GitLab MR Database.
|
|
*
|
|
* @param object $MRList
|
|
* @access public
|
|
* @return void
|
|
*/
|
|
public function batchSyncMR($MRList)
|
|
{
|
|
if(!empty($MRList)) foreach($MRList as $key => $MR)
|
|
{
|
|
if($MR->status != 'opened') continue;
|
|
$rawMR = $this->apiGetSingleMR($MR->gitlabID, $MR->targetProject, $MR->mriid);
|
|
|
|
if(isset($rawMR->iid))
|
|
{
|
|
/* create gitlab mr todo to zentao todo */
|
|
$this->batchSyncTodo($MR->gitlabID, $MR->targetProject);
|
|
|
|
$map = $this->config->mr->maps->sync;
|
|
$gitlabUsers = $this->gitlab->getUserIdAccountPairs($MR->gitlabID);
|
|
|
|
$newMR = new stdclass;
|
|
|
|
foreach($map as $syncField => $config)
|
|
{
|
|
$value = '';
|
|
list($field, $optionType, $options) = explode('|', $config);
|
|
|
|
if($optionType == 'field') $value = $rawMR->$field;
|
|
if($optionType == 'userPairs')
|
|
{
|
|
$gitlabUserID = '';
|
|
if(isset($rawMR->$field[0]))
|
|
{
|
|
$gitlabUserID = $rawMR->$field[0]->$options;
|
|
}
|
|
$value = zget($gitlabUsers, $gitlabUserID, '');
|
|
}
|
|
|
|
if($value) $newMR->$syncField = $value;
|
|
}
|
|
|
|
/* For compatibility with PHP 5.4 . */
|
|
$condition = (array)$newMR;
|
|
if(empty($condition)) continue;
|
|
|
|
/* Update MR in Zentao database. */
|
|
$this->dao->update(TABLE_MR)->data($newMR)
|
|
->where('id')->eq($MR->id)
|
|
->exec();
|
|
|
|
/* Refetch MR in Zentao database. */
|
|
$MR = $this->dao->findByID($MR->id)->from(TABLE_MR)->fetch();
|
|
$MRList[$key] = $MR;
|
|
}
|
|
}
|
|
|
|
return $MRList;
|
|
}
|
|
|
|
/**
|
|
* Sync GitLab Todo to ZenTao Todo.
|
|
*
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @access public
|
|
* @return void
|
|
*/
|
|
public function batchSyncTodo($gitlabID, $projectID)
|
|
{
|
|
/* It can only get todo from GitLab API by its assignee. So here should use sudo as the assignee to get the todo list. */
|
|
/* In this case, ignore sync todo for reviewer due to an issue in GitLab API. */
|
|
$accountList = $this->dao->select('assignee')->from(TABLE_MR)
|
|
->where('deleted')->eq('0')
|
|
->andWhere('status')->eq('opened')
|
|
->andWhere('gitlabID')->eq($gitlabID)
|
|
->andWhere('targetProject')->eq($projectID)
|
|
->fetchPairs();
|
|
|
|
foreach($accountList as $account)
|
|
{
|
|
$accountPair = $this->getSudoAccountPair($gitlabID, $projectID, $account);
|
|
if(!empty($accountPair) and isset($accountPair[$account]))
|
|
{
|
|
$sudo = $accountPair[$account];
|
|
$todoList = $this->gitlab->apiGetTodoList($gitlabID, $projectID, $sudo);
|
|
|
|
foreach($todoList as $rawTodo)
|
|
{
|
|
$todoDesc = $this->dao->select('*')
|
|
->from(TABLE_TODO)
|
|
->where('idvalue')->eq($rawTodo->id)
|
|
->fetch();
|
|
if(empty($todoDesc))
|
|
{
|
|
$todo = new stdClass;
|
|
$todo->account = $this->app->user->account;
|
|
$todo->assignedTo = $account;
|
|
$todo->assignedBy = $this->app->user->account;
|
|
$todo->date = date("Y-m-d", strtotime($rawTodo->target->created_at));
|
|
$todo->assignedDate = $rawTodo->target->created_at;
|
|
$todo->begin = '2400'; /* 2400 means begin is 'undefined'. */
|
|
$todo->end = '2400'; /* 2400 means end is 'undefined'. */
|
|
$todo->type = 'custom';
|
|
$todo->idvalue = $rawTodo->id;
|
|
$todo->pri = 3;
|
|
$todo->name = $this->lang->mr->common . ": " . $rawTodo->target->title;
|
|
$todo->desc = $rawTodo->target->assignee->name . ' ' . $this->lang->mr->at . ' ' . '<a href="' . $this->gitlab->apiGetSingleProject($gitlabID, $projectID)->web_url . '" target="_blank">' . $rawTodo->project->path .'</a>' . ' ' . $this->lang->mr->todomessage . '<a href="' . $rawTodo->target->web_url . '" target="_blank">' . ' ' . $this->lang->mr->common .'</a>' . '。';
|
|
$todo->status = 'wait';
|
|
$todo->finishedBy = '';
|
|
|
|
$this->dao->insert(TABLE_TODO)->data($todo)->exec();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get a list of todo items.
|
|
*
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function todoDescriptionLink($gitlabID, $projectID)
|
|
{
|
|
$gitlab = $this->gitlab->getByID($gitlabID);
|
|
if(!$gitlab) return '';
|
|
return rtrim($gitlab->url, '/')."/dashboard/todos?project_id=$projectID&type=MergeRequest";
|
|
}
|
|
|
|
|
|
/**
|
|
* Create MR by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @param object $MR
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiCreateMR($gitlabID, $projectID, $MR)
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests");
|
|
return json_decode(commonModel::http($url, $MR));
|
|
}
|
|
|
|
/**
|
|
* Get MR list by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#list-project-merge-requests
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiGetMRList($gitlabID, $projectID)
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests");
|
|
return json_decode(commonModel::http($url));
|
|
}
|
|
|
|
/**
|
|
* Get single MR by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr
|
|
* @param int $gitlabID
|
|
* @param int $projectID targetProject
|
|
* @param int $MRID
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiGetSingleMR($gitlabID, $projectID, $MRID)
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests/$MRID");
|
|
return json_decode(commonModel::http($url));
|
|
}
|
|
|
|
/**
|
|
* Update MR by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#update-mr
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @param int $MRID
|
|
* @param object $MR
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiUpdateMR($gitlabID, $projectID, $MRID, $MR)
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests/$MRID");
|
|
return json_decode(commonModel::http($url, $MR, $options = array(CURLOPT_CUSTOMREQUEST => 'PUT')));
|
|
}
|
|
|
|
/**
|
|
* Delete MR by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#delete-a-merge-request
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @param int $MRID
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiDeleteMR($gitlabID, $projectID, $MRID)
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests/$MRID");
|
|
return json_decode(commonModel::http($url, null, array(CURLOPT_CUSTOMREQUEST => 'DELETE')));
|
|
}
|
|
|
|
/**
|
|
* Accept MR by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @param int $MRID
|
|
* @param string $sudo
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiAcceptMR($gitlabID, $projectID, $MRID, $sudo = "")
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests/$MRID/merge");
|
|
if($sudo != "") return json_decode(commonModel::http($url, $data = null, $options = array(CURLOPT_CUSTOMREQUEST => 'PUT'), $headers = array("sudo: {$sudo}")));
|
|
return json_decode(commonModel::http($url, $data = null, $options = array(CURLOPT_CUSTOMREQUEST => 'PUT')));
|
|
}
|
|
|
|
/**
|
|
* Get MR diff versions by API.
|
|
*
|
|
* @docs https://docs.gitlab.com/ee/api/merge_requests.html#get-mr-diff-versions
|
|
* @param object $MR
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function getDiffs($MR)
|
|
{
|
|
$gitlab = $this->gitlab->getByID($MR->gitlabID);
|
|
|
|
$this->loadModel('repo');
|
|
$repo = new stdclass;
|
|
$repo->SCM = 'GitLab';
|
|
$repo->gitlab = $gitlab->id;
|
|
$repo->project = $MR->targetProject;
|
|
$repo->path = sprintf($this->config->repo->gitlab->apiPath, $gitlab->url, $MR->targetProject);
|
|
$repo->client = $gitlab->url;
|
|
$repo->password = $gitlab->token;
|
|
|
|
$scm = $this->app->loadClass('scm');
|
|
$scm->setEngine($repo);
|
|
|
|
$encoding = empty($encoding) ? $repo->encoding : $encoding;
|
|
$encoding = strtolower(str_replace('_', '-', $encoding));
|
|
return $scm->diff('', $MR->sourceBranch, $MR->targetBranch, $parse = true, $MR->sourceProject);
|
|
}
|
|
|
|
/**
|
|
* Get sudo account pair, such as "zentao account" => "gitlab account|id".
|
|
*
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @param int $account
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function getSudoAccountPair($gitlabID, $projectID, $account)
|
|
{
|
|
$bindedUsers = $this->gitlab->getUserAccountIdPairs($gitlabID);
|
|
$accuntPair = array();
|
|
if(isset($bindedUsers[$account])) $accuntPair[$account] = $bindedUsers[$account];
|
|
return $accuntPair;
|
|
}
|
|
|
|
/**
|
|
* Get sudo user ID in both GitLab and Project.
|
|
* Note: sudo parameter in GitLab API can be user ID or username.
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @access public
|
|
* @return int|string
|
|
*/
|
|
public function getSudoUsername($gitlabID, $projectID)
|
|
{
|
|
$zentaoUser = $this->app->user->account;
|
|
|
|
/* Fetch user list both in Zentao and current GitLab project. */
|
|
$bindedUsers = $this->gitlab->getUserAccountIdPairs($gitlabID);
|
|
$rawProjectUsers = $this->gitlab->apiGetProjectUsers($gitlabID, $projectID);
|
|
$users = array();
|
|
foreach($rawProjectUsers as $rawProjectUser)
|
|
{
|
|
if(!empty($bindedUsers[$rawProjectUser->username])) $users[$rawProjectUser->username] = $bindedUsers[$rawProjectUser->username];
|
|
}
|
|
if(!empty($users[$zentaoUser])) return $users[$zentaoUser];
|
|
return "";
|
|
}
|
|
|
|
/**
|
|
* Create a todo item for merge request.
|
|
*
|
|
* @param int $gitlabID
|
|
* @param int $projectID
|
|
* @param int $MRID
|
|
* @access public
|
|
* @return object
|
|
*/
|
|
public function apiCreateMRTodo($gitlabID, $projectID, $MRID)
|
|
{
|
|
$url = sprintf($this->gitlab->getApiRoot($gitlabID), "/projects/$projectID/merge_requests/$MRID/todo");
|
|
return json_decode(commonModel::http($url, $data = null, $options = array(CURLOPT_CUSTOMREQUEST => 'POST')));
|
|
}
|
|
}
|