mirror of https://github.com/MISP/MISP
414 lines
13 KiB
PHP
414 lines
13 KiB
PHP
<?php
|
|
App::uses('AppModel', 'Model');
|
|
|
|
class Tag extends AppModel
|
|
{
|
|
public $useTable = 'tags';
|
|
|
|
public $displayField = 'name';
|
|
|
|
public $actsAs = array(
|
|
'SysLogLogable.SysLogLogable' => array( // TODO Audit, logable
|
|
'roleModel' => 'Tag',
|
|
'roleKey' => 'tag_id',
|
|
'change' => 'full'
|
|
),
|
|
'Containable'
|
|
);
|
|
|
|
public $validate = array(
|
|
'name' => array(
|
|
'required' => array(
|
|
'rule' => array('notBlank', 'name'),
|
|
'message' => 'This field is required.'
|
|
),
|
|
'valueNotEmpty' => array(
|
|
'rule' => array('valueNotEmpty', 'name'),
|
|
),
|
|
'unique' => array(
|
|
'rule' => 'isUnique',
|
|
'message' => 'A similar name already exists.',
|
|
),
|
|
),
|
|
'colour' => array(
|
|
'valueNotEmpty' => array(
|
|
'rule' => array('valueNotEmpty', 'colour'),
|
|
),
|
|
'userdefined' => array(
|
|
'rule' => 'validateColour',
|
|
'message' => 'Colour has to be in the RGB format (#FFFFFF)',
|
|
),
|
|
),
|
|
);
|
|
|
|
public $hasMany = array(
|
|
'EventTag' => array(
|
|
'className' => 'EventTag',
|
|
'dependent' => true
|
|
),
|
|
'TemplateTag',
|
|
'FavouriteTag' => array(
|
|
'dependent' => true
|
|
),
|
|
'AttributeTag' => array(
|
|
'dependent' => true
|
|
)
|
|
);
|
|
|
|
public $belongsTo = array(
|
|
'Organisation' => array(
|
|
'className' => 'Organisation',
|
|
'foreignKey' => 'org_id',
|
|
),
|
|
'User' => array(
|
|
'className' => 'User',
|
|
'foreignKey' => 'user_id',
|
|
)
|
|
);
|
|
|
|
public function beforeValidate($options = array())
|
|
{
|
|
parent::beforeValidate();
|
|
if (!isset($this->data['Tag']['org_id'])) {
|
|
$this->data['Tag']['org_id'] = 0;
|
|
}
|
|
if (!isset($this->data['Tag']['user_id'])) {
|
|
$this->data['Tag']['user_id'] = 0;
|
|
}
|
|
if (!isset($this->data['Tag']['hide_tag'])) {
|
|
$this->data['Tag']['hide_tag'] = Configure::read('MISP.incoming_tags_disabled_by_default') ? 1 : 0;
|
|
}
|
|
if (!isset($this->data['Tag']['exportable'])) {
|
|
$this->data['Tag']['exportable'] = 1;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function afterSave($created, $options = array())
|
|
{
|
|
parent::afterSave($created, $options);
|
|
if (Configure::read('Plugin.ZeroMQ_enable') && Configure::read('Plugin.ZeroMQ_tag_notifications_enable')) {
|
|
$pubSubTool = $this->getPubSubTool();
|
|
$tag = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'conditions' => array('Tag.id' => $this->id)
|
|
));
|
|
$action = $created ? 'add' : 'edit';
|
|
$pubSubTool->tag_save($tag, $action);
|
|
}
|
|
}
|
|
|
|
public function beforeDelete($cascade = true)
|
|
{
|
|
if (Configure::read('Plugin.ZeroMQ_enable') && Configure::read('Plugin.ZeroMQ_tag_notifications_enable')) {
|
|
if (!empty($this->id)) {
|
|
$pubSubTool = $this->getPubSubTool();
|
|
$tag = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'conditions' => array('Tag.id' => $this->id)
|
|
));
|
|
$pubSubTool->tag_save($tag, 'delete');
|
|
}
|
|
}
|
|
}
|
|
|
|
public function validateColour($fields)
|
|
{
|
|
if (!preg_match('/^#[0-9a-f]{6}$/i', $fields['colour'])) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function lookupTagIdFromName($tagName)
|
|
{
|
|
$tagId = $this->find('first', array(
|
|
'conditions' => array('LOWER(Tag.name)' => strtolower($tagName)),
|
|
'recursive' => -1,
|
|
'fields' => array('Tag.id')
|
|
));
|
|
if (empty($tagId)) {
|
|
return -1;
|
|
} else {
|
|
return $tagId['Tag']['id'];
|
|
}
|
|
}
|
|
|
|
// find all of the tag ids that belong to the accepted tag names and the rejected tag names
|
|
public function fetchTagIdsFromFilter($accept = array(), $reject = array())
|
|
{
|
|
$results = array(0 => array(), 1 => array());
|
|
if (!empty($accept)) {
|
|
foreach ($accept as $tag) {
|
|
$temp = $this->lookupTagIdFromName($tag);
|
|
if (!in_array($temp, $results[0])) {
|
|
$results[0][] = $temp;
|
|
}
|
|
}
|
|
}
|
|
if (!empty($reject)) {
|
|
foreach ($reject as $tag) {
|
|
$temp = $this->lookupTagIdFromName($tag);
|
|
if (!in_array($temp, $results[1])) {
|
|
$results[1][] = $temp;
|
|
}
|
|
}
|
|
}
|
|
return $results;
|
|
}
|
|
|
|
// find all of the event Ids that belong to the accepted tags and the rejected tags
|
|
public function fetchEventTagIds($accept = array(), $reject = array())
|
|
{
|
|
$acceptIds = array();
|
|
$rejectIds = array();
|
|
if (!empty($accept)) {
|
|
$acceptIds = $this->findEventIdsByTagNames($accept);
|
|
if (empty($acceptIds)) {
|
|
$acceptIds[] = -1;
|
|
}
|
|
}
|
|
if (!empty($reject)) {
|
|
$rejectIds = $this->findEventIdsByTagNames($reject);
|
|
}
|
|
return array($acceptIds, $rejectIds);
|
|
}
|
|
|
|
// find all of the tag Ids that belong to the accepted tags and the rejected tags
|
|
public function fetchTagIds($accept = array(), $reject = array())
|
|
{
|
|
$acceptIds = array();
|
|
$rejectIds = array();
|
|
if (!empty($accept)) {
|
|
$acceptIds = $this->findTagIdsByTagNames($accept);
|
|
if (empty($acceptIds)) {
|
|
$acceptIds[] = -1;
|
|
}
|
|
}
|
|
if (!empty($reject)) {
|
|
$rejectIds = $this->findTagIdsByTagNames($reject);
|
|
}
|
|
return array($acceptIds, $rejectIds);
|
|
}
|
|
|
|
// pass a list of tag names to receive a list of matched tag IDs
|
|
public function findTagIdsByTagNames($array)
|
|
{
|
|
$ids = array();
|
|
$tag_ids = array();
|
|
if (!is_array($array)) {
|
|
$array = array($array);
|
|
}
|
|
foreach ($array as $k => $tag) {
|
|
if (is_numeric($tag)) {
|
|
$tag_ids[] = $tag;
|
|
unset($array[$k]);
|
|
}
|
|
}
|
|
$array = array_values($array);
|
|
if (!empty($array)) {
|
|
foreach ($array as $a) {
|
|
$conditions['OR'][] = array('LOWER(Tag.name) like' => strtolower($a));
|
|
}
|
|
$params = array(
|
|
'recursive' => 1,
|
|
'conditions' => $conditions,
|
|
'fields' => array('Tag.id', 'Tag.id')
|
|
);
|
|
$result = $this->find('list', $params);
|
|
$tag_ids = array_merge($result, $tag_ids);
|
|
}
|
|
return array_values($tag_ids);
|
|
}
|
|
|
|
public function findEventIdsByTagNames($array)
|
|
{
|
|
$ids = array();
|
|
foreach ($array as $a) {
|
|
if (is_numeric($a)) {
|
|
$conditions['OR'][] = array('id' => $a);
|
|
} else {
|
|
$conditions['OR'][] = array('LOWER(name) like' => strtolower($a));
|
|
}
|
|
}
|
|
$params = array(
|
|
'recursive' => 1,
|
|
'contain' => 'EventTag',
|
|
'conditions' => $conditions
|
|
);
|
|
$result = $this->find('all', $params);
|
|
foreach ($result as $tag) {
|
|
foreach ($tag['EventTag'] as $eventTag) {
|
|
$ids[] = $eventTag['event_id'];
|
|
}
|
|
}
|
|
return $ids;
|
|
}
|
|
|
|
public function findAttributeIdsByAttributeTagNames($array)
|
|
{
|
|
$ids = array();
|
|
foreach ($array as $a) {
|
|
$conditions['OR'][] = array('LOWER(name) LIKE' => strtolower($a));
|
|
}
|
|
$params = array(
|
|
'recursive' => 1,
|
|
'contain' => 'AttributeTag',
|
|
'conditions' => $conditions
|
|
);
|
|
$result = $this->find('all', $params);
|
|
foreach ($result as $tag) {
|
|
foreach ($tag['AttributeTag'] as $attributeTag) {
|
|
$ids[] = $attributeTag['attribute_id'];
|
|
}
|
|
}
|
|
return $ids;
|
|
}
|
|
|
|
public function captureTag($tag, $user)
|
|
{
|
|
$existingTag = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'conditions' => array('LOWER(name)' => strtolower($tag['name']))
|
|
));
|
|
if (empty($existingTag)) {
|
|
if ($user['Role']['perm_tag_editor']) {
|
|
$this->create();
|
|
if (!isset($tag['colour']) || empty($tag['colour'])) {
|
|
$tag['colour'] = $this->random_color();
|
|
}
|
|
$tag = array(
|
|
'name' => $tag['name'],
|
|
'colour' => $tag['colour'],
|
|
'exportable' => isset($tag['exportable']) ? $tag['exportable'] : 1,
|
|
'org_id' => 0,
|
|
'user_id' => 0,
|
|
'hide_tag' => Configure::read('MISP.incoming_tags_disabled_by_default') ? 1 : 0
|
|
);
|
|
$this->save($tag);
|
|
return $this->id;
|
|
} else {
|
|
return false;
|
|
}
|
|
} else {
|
|
if (
|
|
!$user['Role']['perm_site_admin'] &&
|
|
$existingTag['Tag']['org_id'] != 0 &&
|
|
$existingTag['Tag']['org_id'] != $user['org_id'] &&
|
|
$existingTag['Tag']['user_id'] != 0 &&
|
|
$existingTag['Tag']['user_id'] != $user['id']
|
|
) {
|
|
return false;
|
|
}
|
|
}
|
|
return $existingTag['Tag']['id'];
|
|
}
|
|
|
|
// find all tags that belong to a given eventId
|
|
public function findEventTags($eventId)
|
|
{
|
|
$tags = array();
|
|
$params = array(
|
|
'recursive' => 1,
|
|
'contain' => 'EventTag',
|
|
);
|
|
$result = $this->find('all', $params);
|
|
foreach ($result as $tag) {
|
|
foreach ($tag['EventTag'] as $eventTag) {
|
|
if ($eventTag['event_id'] == $eventId) {
|
|
$tags[] = $tag['Tag'];
|
|
}
|
|
}
|
|
}
|
|
return $tags;
|
|
}
|
|
|
|
public function random_color()
|
|
{
|
|
$colour = '#';
|
|
for ($i = 0; $i < 3; $i++) {
|
|
$colour .= str_pad(dechex(mt_rand(0, 255)), 2, '0', STR_PAD_LEFT);
|
|
}
|
|
return $colour;
|
|
}
|
|
|
|
public function quickAdd($name, $colour = false, $returnId = false)
|
|
{
|
|
$this->create();
|
|
if ($colour === false) {
|
|
$colour = $this->random_color();
|
|
}
|
|
$data = array(
|
|
'name' => $name,
|
|
'colour' => $colour,
|
|
'exportable' => 1
|
|
);
|
|
return ($this->save($data));
|
|
}
|
|
|
|
public function quickEdit($tag, $name, $colour, $hide = false)
|
|
{
|
|
if ($tag['Tag']['colour'] !== $colour || $tag['Tag']['name'] !== $name || $hide !== false) {
|
|
$tag['Tag']['name'] = $name;
|
|
$tag['Tag']['colour'] = $colour;
|
|
if ($hide !== false) {
|
|
$tag['Tag']['hide_tag'] = $hide;
|
|
}
|
|
return ($this->save($tag['Tag']));
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function disableTags($tags)
|
|
{
|
|
foreach ($tags as $k => $v) {
|
|
$tags[$k]['Tag']['hide_tag'] = 1;
|
|
}
|
|
return ($this->saveAll($tags));
|
|
}
|
|
|
|
public function getTagsForNamespace($namespace)
|
|
{
|
|
$contain = array('EventTag');
|
|
$contain[] = 'AttributeTag';
|
|
$tags_temp = $this->find('all', array(
|
|
'recursive' => -1,
|
|
'contain' => $contain,
|
|
'conditions' => array('UPPER(name) LIKE' => strtoupper($namespace) . '%'),
|
|
));
|
|
$tags = array();
|
|
foreach ($tags_temp as $temp) {
|
|
$tags[strtoupper($temp['Tag']['name'])] = $temp;
|
|
}
|
|
return $tags;
|
|
}
|
|
|
|
public function fetchSimpleEventsForTag($id, $user, $useTagName = false)
|
|
{
|
|
if ($useTagName) {
|
|
$tag = $this->find('first', array(
|
|
'recursive' => -1,
|
|
'fields' => array('Tag.id'),
|
|
'conditions' => array('Tag.name' => $id)
|
|
));
|
|
if (empty($tag)) {
|
|
return array();
|
|
}
|
|
$id = $tag['Tag']['id'];
|
|
}
|
|
$event_ids = $this->EventTag->find('list', array(
|
|
'recursive' => -1,
|
|
'conditions' => array('EventTag.tag_id' => $id),
|
|
'fields' => array('EventTag.event_id', 'EventTag.event_id'),
|
|
'order' => array('EventTag.event_id')
|
|
));
|
|
$params = array('conditions' => array('Event.id' => array_values($event_ids)));
|
|
$events = $this->EventTag->Event->fetchSimpleEvents($user, $params, true);
|
|
foreach ($events as $k => $event) {
|
|
$event['Event']['Orgc'] = $event['Orgc'];
|
|
$events[$k] = $event['Event'];
|
|
}
|
|
return $events;
|
|
}
|
|
}
|