diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-03-04 17:38:17 -0500 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-03-04 17:38:17 -0500 |
commit | c083822806e075fd1932d7ce86903b4df967babb (patch) | |
tree | 440114750691cac6925c03c70be62f14264c7b30 /app/Import | |
parent | 0d03c525a1aa1d54f01e754f762a19c19100c209 (diff) |
Create Import namespace and move classes
Diffstat (limited to 'app/Import')
-rw-r--r-- | app/Import/TaskImport.php | 157 | ||||
-rw-r--r-- | app/Import/UserImport.php | 120 |
2 files changed, 277 insertions, 0 deletions
diff --git a/app/Import/TaskImport.php b/app/Import/TaskImport.php new file mode 100644 index 00000000..2abafe14 --- /dev/null +++ b/app/Import/TaskImport.php @@ -0,0 +1,157 @@ +<?php + +namespace Kanboard\Import; + +use Kanboard\Core\Base; +use Kanboard\Core\Csv; +use SimpleValidator\Validator; +use SimpleValidator\Validators; + +/** + * Task Import + * + * @package import + * @author Frederic Guillot + */ +class TaskImport extends Base +{ + /** + * Number of successful import + * + * @access public + * @var integer + */ + public $counter = 0; + + /** + * Project id to import tasks + * + * @access public + * @var integer + */ + public $projectId; + + /** + * Get mapping between CSV header and SQL columns + * + * @access public + * @return array + */ + public function getColumnMapping() + { + return array( + 'reference' => 'Reference', + 'title' => 'Title', + 'description' => 'Description', + 'assignee' => 'Assignee Username', + 'creator' => 'Creator Username', + 'color' => 'Color Name', + 'column' => 'Column Name', + 'category' => 'Category Name', + 'swimlane' => 'Swimlane Name', + 'score' => 'Complexity', + 'time_estimated' => 'Time Estimated', + 'time_spent' => 'Time Spent', + 'date_due' => 'Due Date', + 'is_active' => 'Closed', + ); + } + + /** + * Import a single row + * + * @access public + * @param array $row + * @param integer $line_number + */ + public function import(array $row, $line_number) + { + $row = $this->prepare($row); + + if ($this->validateCreation($row)) { + if ($this->taskCreation->create($row) > 0) { + $this->logger->debug('TaskImport: imported successfully line '.$line_number); + $this->counter++; + } else { + $this->logger->error('TaskImport: creation error at line '.$line_number); + } + } else { + $this->logger->error('TaskImport: validation error at line '.$line_number); + } + } + + /** + * Format row before validation + * + * @access public + * @param array $row + * @return array + */ + public function prepare(array $row) + { + $values = array(); + $values['project_id'] = $this->projectId; + $values['reference'] = $row['reference']; + $values['title'] = $row['title']; + $values['description'] = $row['description']; + $values['is_active'] = Csv::getBooleanValue($row['is_active']) == 1 ? 0 : 1; + $values['score'] = (int) $row['score']; + $values['time_estimated'] = (float) $row['time_estimated']; + $values['time_spent'] = (float) $row['time_spent']; + + if (! empty($row['assignee'])) { + $values['owner_id'] = $this->user->getIdByUsername($row['assignee']); + } + + if (! empty($row['creator'])) { + $values['creator_id'] = $this->user->getIdByUsername($row['creator']); + } + + if (! empty($row['color'])) { + $values['color_id'] = $this->color->find($row['color']); + } + + if (! empty($row['column'])) { + $values['column_id'] = $this->column->getColumnIdByTitle($this->projectId, $row['column']); + } + + if (! empty($row['category'])) { + $values['category_id'] = $this->category->getIdByName($this->projectId, $row['category']); + } + + if (! empty($row['swimlane'])) { + $values['swimlane_id'] = $this->swimlane->getIdByName($this->projectId, $row['swimlane']); + } + + if (! empty($row['date_due'])) { + $values['date_due'] = $this->dateParser->getTimestampFromIsoFormat($row['date_due']); + } + + $this->helper->model->removeEmptyFields( + $values, + array('owner_id', 'creator_id', 'color_id', 'column_id', 'category_id', 'swimlane_id', 'date_due') + ); + + return $values; + } + + /** + * Validate user creation + * + * @access public + * @param array $values + * @return boolean + */ + public function validateCreation(array $values) + { + $v = new Validator($values, array( + new Validators\Integer('project_id', t('This value must be an integer')), + new Validators\Required('project_id', t('The project is required')), + new Validators\Required('title', t('The title is required')), + new Validators\MaxLength('title', t('The maximum length is %d characters', 200), 200), + new Validators\MaxLength('reference', t('The maximum length is %d characters', 50), 50), + )); + + return $v->execute(); + } +} diff --git a/app/Import/UserImport.php b/app/Import/UserImport.php new file mode 100644 index 00000000..64300d77 --- /dev/null +++ b/app/Import/UserImport.php @@ -0,0 +1,120 @@ +<?php + +namespace Kanboard\Import; + +use Kanboard\Model\User; +use SimpleValidator\Validator; +use SimpleValidator\Validators; +use Kanboard\Core\Security\Role; +use Kanboard\Core\Base; +use Kanboard\Core\Csv; + +/** + * User Import + * + * @package import + * @author Frederic Guillot + */ +class UserImport extends Base +{ + /** + * Number of successful import + * + * @access public + * @var integer + */ + public $counter = 0; + + /** + * Get mapping between CSV header and SQL columns + * + * @access public + * @return array + */ + public function getColumnMapping() + { + return array( + 'username' => 'Username', + 'password' => 'Password', + 'email' => 'Email', + 'name' => 'Full Name', + 'is_admin' => 'Administrator', + 'is_manager' => 'Manager', + 'is_ldap_user' => 'Remote User', + ); + } + + /** + * Import a single row + * + * @access public + * @param array $row + * @param integer $line_number + */ + public function import(array $row, $line_number) + { + $row = $this->prepare($row); + + if ($this->validateCreation($row)) { + if ($this->user->create($row)) { + $this->logger->debug('UserImport: imported successfully line '.$line_number); + $this->counter++; + } else { + $this->logger->error('UserImport: creation error at line '.$line_number); + } + } else { + $this->logger->error('UserImport: validation error at line '.$line_number); + } + } + + /** + * Format row before validation + * + * @access public + * @param array $row + * @return array + */ + public function prepare(array $row) + { + $row['username'] = strtolower($row['username']); + + foreach (array('is_admin', 'is_manager', 'is_ldap_user') as $field) { + $row[$field] = Csv::getBooleanValue($row[$field]); + } + + if ($row['is_admin'] == 1) { + $row['role'] = Role::APP_ADMIN; + } elseif ($row['is_manager'] == 1) { + $row['role'] = Role::APP_MANAGER; + } else { + $row['role'] = Role::APP_USER; + } + + unset($row['is_admin']); + unset($row['is_manager']); + + $this->helper->model->removeEmptyFields($row, array('password', 'email', 'name')); + + return $row; + } + + /** + * Validate user creation + * + * @access public + * @param array $values + * @return boolean + */ + public function validateCreation(array $values) + { + $v = new Validator($values, array( + new Validators\MaxLength('username', t('The maximum length is %d characters', 50), 50), + new Validators\Unique('username', t('The username must be unique'), $this->db->getConnection(), User::TABLE, 'id'), + new Validators\MinLength('password', t('The minimum length is %d characters', 6), 6), + new Validators\Email('email', t('Email address invalid')), + new Validators\Integer('is_ldap_user', t('This value must be an integer')), + )); + + return $v->execute(); + } +} |