data/Relationships/M2MRelationship.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 require_once("data/Relationships/SugarRelationship.php");
  40
  41 /**
  42  * Represents a many to many relationship that is table based.
  43  * @api
  44  */
  45 class M2MRelationship extends SugarRelationship
  46 {
  47     var $type = "many-to-many";
  48
  49     public function __construct($def)
  50     {
  51         $this->def = $def;
  52         $this->name = $def['name'];
  53
  54         $lhsModule = $def['lhs_module'];
  55         $this->lhsLinkDef = $this->getLinkedDefForModuleByRelationship($lhsModule);
  56         $this->lhsLink = $this->lhsLinkDef['name'];
  57
  58         $rhsModule = $def['rhs_module'];
  59         $this->rhsLinkDef = $this->getLinkedDefForModuleByRelationship($rhsModule);
  60         $this->rhsLink = $this->rhsLinkDef['name'];
  61
  62         $this->self_referencing = $lhsModule == $rhsModule;
  63     }
  64
  65     /**
  66      * Find the link entry for a particular relationship and module.
  67      *
  68      * @param $module
  69      * @return array|bool
  70      */
  71     public function getLinkedDefForModuleByRelationship($module)
  72     {
  73         $results = VardefManager::getLinkFieldForRelationship( $module, BeanFactory::getObjectName($module), $this->name);
  74         //Only a single link was found
  75         if( isset($results['name']) )
  76         {
  77             return $results;
  78         }
  79         //Multiple links with same relationship name
  80         else if( is_array($results) )
  81         {
  82             $GLOBALS['log']->error("Warning: Multiple links found for relationship {$this->name} within module {$module}");
  83             return $this->getMostAppropriateLinkedDefinition($results);
  84         }
  85         else
  86         {
  87             return FALSE;
  88         }
  89     }
  90
  91     /**
  92      * Find the most 'appropriate' link entry for a relationship/module in which there are multiple link entries with the
  93      * same relationship name.
  94      *
  95      * @param $links
  96      * @return bool
  97      */
  98     protected function getMostAppropriateLinkedDefinition($links)
  99     {
 100         //First priority is to find a link name that matches the relationship name
 101         foreach($links as $link)
 102         {
 103             if( isset($link['name']) && $link['name'] == $this->name )
 104             {
 105                 return $link;
 106             }
 107         }
 108         //Next would be a relationship that has a side defined
 109         foreach($links as $link)
 110         {
 111             if( isset($link['id_name']))
 112             {
 113                 return $link;
 114             }
 115         }
 116         //Unable to find an appropriate link, guess and use the first one
 117         $GLOBALS['log']->error("Unable to determine best appropriate link for relationship {$this->name}");
 118         return $links[0];
 119     }
 120     /**
 121      * @param  $lhs SugarBean left side bean to add to the relationship.
 122      * @param  $rhs SugarBean right side bean to add to the relationship.
 123      * @param  $additionalFields key=>value pairs of fields to save on the relationship
 124      * @return boolean true if successful
 125      */
 126     public function add($lhs, $rhs, $additionalFields = array())
 127     {
 128         $lhsLinkName = $this->lhsLink;
 129         $rhsLinkName = $this->rhsLink;
 130
 131         if (empty($lhs->$lhsLinkName) && !$lhs->load_relationship($lhsLinkName))
 132         {
 133             $lhsClass = get_class($lhs);
 134             $GLOBALS['log']->fatal("could not load LHS $lhsLinkName in $lhsClass");
 135             return false;
 136         }
 137         if (empty($rhs->$rhsLinkName) && !$rhs->load_relationship($rhsLinkName))
 138         {
 139             $rhsClass = get_class($rhs);
 140             $GLOBALS['log']->fatal("could not load RHS $rhsLinkName in $rhsClass");
 141             return false;
 142         }
 143
 144             $lhs->$lhsLinkName->addBean($rhs);
 145             $rhs->$rhsLinkName->addBean($lhs);
 146
 147             $this->callBeforeAdd($lhs, $rhs, $lhsLinkName);
 148             $this->callBeforeAdd($rhs, $lhs, $rhsLinkName);
 149
 150         //Many to many has no additional logic, so just add a new row to the table and notify the beans.
 151         $dataToInsert = $this->getRowToInsert($lhs, $rhs, $additionalFields);
 152
 153         $this->addRow($dataToInsert);
 154
 155         if ($this->self_referencing)
 156             $this->addSelfReferencing($lhs, $rhs, $additionalFields);
 157
 158             $lhs->$lhsLinkName->addBean($rhs);
 159             $rhs->$rhsLinkName->addBean($lhs);
 160
 161             $this->callAfterAdd($lhs, $rhs, $lhsLinkName);
 162             $this->callAfterAdd($rhs, $lhs, $rhsLinkName);
 163
 164         return true;
 165     }
 166
 167     protected function getRowToInsert($lhs, $rhs, $additionalFields = array())
 168     {
 169         $row = array(
 170             "id" => create_guid(),
 171             $this->def['join_key_lhs'] => $lhs->id,
 172             $this->def['join_key_rhs'] => $rhs->id,
 173             'date_modified' => TimeDate::getInstance()->nowDb(),
 174             'deleted' => 0,
 175         );
 176
 177
 178         if (!empty($this->def['relationship_role_column']) && !empty($this->def['relationship_role_column_value']) && !$this->ignore_role_filter )
 179         {
 180             $row[$this->relationship_role_column] = $this->relationship_role_column_value;
 181         }
 182
 183         if (!empty($this->def['fields']))
 184         {
 185             foreach($this->def['fields'] as $fieldDef)
 186             {
 187                 if (!empty($fieldDef['name']) && !isset($row[$fieldDef['name']]) && !empty($fieldDef['default']))
 188                 {
 189                     $row[$fieldDef['name']] = $fieldDef['default'];
 190                 }
 191             }
 192         }
 193         if (!empty($additionalFields))
 194         {
 195             $row = array_merge($row, $additionalFields);
 196         }
 197
 198         return $row;
 199     }
 200
 201     /**
 202      * Adds the reversed version of this relationship to the table so that it can be accessed from either side equally
 203      * @param $lhs
 204      * @param $rhs
 205      * @param array $additionalFields
 206      * @return void
 207      */
 208     protected function addSelfReferencing($lhs, $rhs, $additionalFields = array())
 209     {
 210         if ($rhs->id != $lhs->id)
 211         {
 212             $dataToInsert = $this->getRowToInsert($rhs, $lhs, $additionalFields);
 213             $this->addRow($dataToInsert);
 214         }
 215     }
 216
 217     public function remove($lhs, $rhs)
 218     {
 219         if(!($lhs instanceof SugarBean) || !($rhs instanceof SugarBean)) {
 220             $GLOBALS['log']->fatal("LHS and RHS must be beans");
 221             return false;
 222         }
 223         $lhsLinkName = $this->lhsLink;
 224         $rhsLinkName = $this->rhsLink;
 225
 226         if (!($lhs instanceof SugarBean)) {
 227             $GLOBALS['log']->fatal("LHS is not a SugarBean object");
 228             return false;
 229         }
 230         if (!($rhs instanceof SugarBean)) {
 231             $GLOBALS['log']->fatal("RHS is not a SugarBean object");
 232             return false;
 233         }
 234         if (empty($lhs->$lhsLinkName) && !$lhs->load_relationship($lhsLinkName))
 235         {
 236             $GLOBALS['log']->fatal("could not load LHS $lhsLinkName");
 237             return false;
 238         }
 239         if (empty($rhs->$rhsLinkName) && !$rhs->load_relationship($rhsLinkName))
 240         {
 241             $GLOBALS['log']->fatal("could not load RHS $rhsLinkName");
 242             return false;
 243         }
 244
 245         if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
 246         {
 247             if ($lhs->$lhsLinkName instanceof Link2)
 248             {
 249                 $lhs->$lhsLinkName->load();
 250                 $this->callBeforeDelete($lhs, $rhs, $lhsLinkName);
 251             }
 252
 253             if ($rhs->$rhsLinkName instanceof Link2)
 254             {
 255                 $rhs->$rhsLinkName->load();
 256                 $this->callBeforeDelete($rhs, $lhs, $rhsLinkName);
 257             }
 258         }
 259
 260         $dataToRemove = array(
 261             $this->def['join_key_lhs'] => $lhs->id,
 262             $this->def['join_key_rhs'] => $rhs->id
 263         );
 264
 265         $this->removeRow($dataToRemove);
 266
 267         if ($this->self_referencing)
 268             $this->removeSelfReferencing($lhs, $rhs);
 269
 270         if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
 271         {
 272             if ($lhs->$lhsLinkName instanceof Link2)
 273             {
 274                 $lhs->$lhsLinkName->load();
 275                 $this->callAfterDelete($lhs, $rhs, $lhsLinkName);
 276             }
 277
 278             if ($rhs->$rhsLinkName instanceof Link2)
 279             {
 280                 $rhs->$rhsLinkName->load();
 281                 $this->callAfterDelete($rhs, $lhs, $rhsLinkName);
 282             }
 283         }
 284
 285         return true;
 286     }
 287
 288     /**
 289      * Removes the reversed version of this relationship
 290      * @param $lhs
 291      * @param $rhs
 292      * @param array $additionalFields
 293      * @return void
 294      */
 295     protected function removeSelfReferencing($lhs, $rhs, $additionalFields = array())
 296     {
 297         if ($rhs->id != $lhs->id)
 298         {
 299             $dataToRemove = array(
 300                 $this->def['join_key_lhs'] => $rhs->id,
 301                 $this->def['join_key_rhs'] => $lhs->id
 302             );
 303             $this->removeRow($dataToRemove);
 304         }
 305     }
 306
 307     /**
 308      * @param  $link Link2 loads the relationship for this link.
 309      * @return void
 310      */
 311     public function load($link, $params = array())
 312     {
 313         $db = DBManagerFactory::getInstance();
 314         $query = $this->getQuery($link, $params);
 315         $result = $db->query($query);
 316         $rows = Array();
 317         $idField = $link->getSide() == REL_LHS ? $this->def['join_key_rhs'] : $this->def['join_key_lhs'];
 318         while ($row = $db->fetchByAssoc($result, FALSE))
 319         {
 320             if (empty($row['id']) && empty($row[$idField]))
 321                 continue;
 322             $id = empty($row['id']) ? $row[$idField] : $row['id'];
 323             $rows[$id] = $row;
 324         }
 325         return array("rows" => $rows);
 326     }
 327
 328     protected function linkIsLHS($link) {
 329         return $link->getSide() == REL_LHS;
 330     }
 331
 332     public function getQuery($link, $params = array())
 333     {
 334         if ($this->linkIsLHS($link)) {
 335             $knownKey = $this->def['join_key_lhs'];
 336             $targetKey = $this->def['join_key_rhs'];
 337             $relatedSeed = BeanFactory::getBean($this->getRHSModule());
 338             if (!empty($params['where']))
 339                 $whereTable = (empty($params['right_join_table_alias']) ? $relatedSeed->table_name : $params['right_join_table_alias']);
 340         }
 341         else
 342         {
 343             $knownKey = $this->def['join_key_rhs'];
 344             $targetKey = $this->def['join_key_lhs'];
 345             $relatedSeed = BeanFactory::getBean($this->getLHSModule());
 346             if (!empty($params['where']))
 347                 $whereTable = (empty($params['left_join_table_alias']) ? $relatedSeed->table_name : $params['left_join_table_alias']);
 348         }
 349         $rel_table = $this->getRelationshipTable();
 350
 351         $where = "$rel_table.$knownKey = '{$link->getFocus()->id}'" . $this->getRoleWhere();
 352
 353         //Add any optional where clause
 354         if (!empty($params['where'])){
 355             $add_where = is_string($params['where']) ? $params['where'] : "$whereTable." . $this->getOptionalWhereClause($params['where']);
 356             if (!empty($add_where))
 357                 $where .= " AND $rel_table.$targetKey=$whereTable.id AND $add_where";
 358         }
 359
 360         $deleted = !empty($params['deleted']) ? 1 : 0;
 361         $from = $rel_table;
 362         if (!empty($params['where']))
 363             $from .= ", $whereTable";
 364
 365         if (empty($params['return_as_array'])) {
 366             $query = "SELECT $targetKey id FROM $from WHERE $where AND $rel_table.deleted=$deleted";
 367             //Limit is not compatible with return_as_array
 368             if (!empty($params['limit']) && $params['limit'] > 0) {
 369                 $offset = isset($params['offset']) ? $params['offset'] : 0;
 370                 $query = DBManagerFactory::getInstance()->limitQuery($query, $offset, $params['limit'], false, "", false);
 371             }
 372             return $query;
 373         }
 374         else
 375         {
 376             return array(
 377                 'select' => "SELECT $targetKey id",
 378                 'from' => "FROM $from",
 379                 'where' => "WHERE $where AND $rel_table.deleted=$deleted",
 380             );
 381         }
 382     }
 383
 384     public function getJoin($link, $params = array(), $return_array = false)
 385     {
 386         $linkIsLHS = $link->getSide() == REL_LHS;
 387         if ($linkIsLHS) {
 388             $startingTable = (empty($params['left_join_table_alias']) ? $link->getFocus()->table_name : $params['left_join_table_alias']);
 389         } else {
 390             $startingTable = (empty($params['right_join_table_alias']) ? $link->getFocus()->table_name : $params['right_join_table_alias']);
 391         }
 392
 393         $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
 394         $startingJoinKey = $linkIsLHS ? $this->def['join_key_lhs'] : $this->def['join_key_rhs'];
 395         $joinTable = $this->getRelationshipTable();
 396         $joinTableWithAlias = $joinTable;
 397         $joinKey = $linkIsLHS ? $this->def['join_key_rhs'] : $this->def['join_key_lhs'];
 398         $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
 399         $targetTableWithAlias = $targetTable;
 400         $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
 401         $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
 402
 403         $join = '';
 404
 405         //Set up any table aliases required
 406         if (!empty($params['join_table_link_alias']))
 407         {
 408             $joinTableWithAlias = $joinTable . " ". $params['join_table_link_alias'];
 409             $joinTable = $params['join_table_link_alias'];
 410         }
 411         if ( ! empty($params['join_table_alias']))
 412         {
 413             $targetTableWithAlias = $targetTable . " ". $params['join_table_alias'];
 414             $targetTable = $params['join_table_alias'];
 415         }
 416
 417         $join1 = "$startingTable.$startingKey=$joinTable.$startingJoinKey";
 418         $join2 = "$targetTable.$targetKey=$joinTable.$joinKey";
 419         $where = "";
 420
 421
 422         //First join the relationship table
 423         $join .= "$join_type $joinTableWithAlias ON $join1 AND $joinTable.deleted=0\n"
 424         //Next add any role filters
 425                . $this->getRoleWhere($joinTable) . "\n"
 426         //Then finally join the related module's table
 427                . "$join_type $targetTableWithAlias ON $join2 AND $targetTable.deleted=0\n";
 428
 429         if($return_array){
 430             return array(
 431                 'join' => $join,
 432                 'type' => $this->type,
 433                 'rel_key' => $joinKey,
 434                 'join_tables' => array($joinTable, $targetTable),
 435                 'where' => $where,
 436                 'select' => "$targetTable.id",
 437             );
 438         }
 439         return $join . $where;
 440     }
 441
 442     /**
 443      * Similar to getQuery or Get join, except this time we are starting from the related table and
 444      * searching for items with id's matching the $link->focus->id
 445      * @param  $link
 446      * @param array $params
 447      * @param bool $return_array
 448      * @return String|Array
 449      */
 450     public function getSubpanelQuery($link, $params = array(), $return_array = false)
 451     {
 452         $targetIsLHS = $link->getSide() == REL_RHS;
 453         $startingTable = $targetIsLHS ? $this->def['lhs_table'] : $this->def['rhs_table'];;
 454         $startingKey = $targetIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
 455         $startingJoinKey = $targetIsLHS ? $this->def['join_key_lhs'] : $this->def['join_key_rhs'];
 456         $joinTable = $this->getRelationshipTable();
 457         $joinTableWithAlias = $joinTable;
 458         $joinKey = $targetIsLHS ? $this->def['join_key_rhs'] : $this->def['join_key_lhs'];
 459         $targetKey = $targetIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
 460         $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
 461
 462         $query = '';
 463
 464         //Set up any table aliases required
 465         if (!empty($params['join_table_link_alias']))
 466         {
 467             $joinTableWithAlias = $joinTable . " ". $params['join_table_link_alias'];
 468             $joinTable = $params['join_table_link_alias'];
 469         }
 470
 471         $where = "$startingTable.$startingKey=$joinTable.$startingJoinKey AND $joinTable.$joinKey='{$link->getFocus()->$targetKey}'";
 472
 473         //Check if we should ignore the role filter.
 474         $ignoreRole = !empty($params['ignore_role']);
 475
 476         //First join the relationship table
 477         $query .= "$join_type $joinTableWithAlias ON $where AND $joinTable.deleted=0\n"
 478         //Next add any role filters
 479                . $this->getRoleWhere($joinTable, $ignoreRole) . "\n";
 480
 481         if (!empty($params['return_as_array'])) {
 482             $return_array = true;
 483         }
 484         if($return_array){
 485             return array(
 486                 'join' => $query,
 487                 'type' => $this->type,
 488                 'rel_key' => $joinKey,
 489                 'join_tables' => array($joinTable),
 490                 'where' => "",
 491                 'select' => " ",
 492             );
 493         }
 494         return $query;
 495
 496     }
 497
 498     protected function getRoleFilterForJoin()
 499     {
 500         $ret = "";
 501         if (!empty($this->relationship_role_column) && !$this->ignore_role_filter)
 502         {
 503             $ret .= " AND ".$this->getRelationshipTable().'.'.$this->relationship_role_column;
 504             //role column value.
 505             if (empty($this->relationship_role_column_value))
 506             {
 507                 $ret.=' IS NULL';
 508             } else {
 509                 $ret.= "='".$this->relationship_role_column_value."'";
 510             }
 511             $ret.= "\n";
 512         }
 513         return $ret;
 514     }
 515
 516     /**
 517      * @param  $lhs
 518      * @param  $rhs
 519      * @return bool
 520      */
 521     public function relationship_exists($lhs, $rhs)
 522     {
 523         $query = "SELECT id FROM {$this->getRelationshipTable()} WHERE {$this->join_key_lhs} = '{$lhs->id}' AND {$this->join_key_rhs} = '{$rhs->id}'";
 524
 525         //Roles can allow for multiple links between two records with different roles
 526         $query .= $this->getRoleWhere() . " and deleted = 0";
 527
 528         return $GLOBALS['db']->getOne($query);
 529     }
 530
 531     /**
 532      * @return Array - set of fields that uniquely identify an entry in this relationship
 533      */
 534     protected function getAlternateKeyFields()
 535     {
 536         $fields = array($this->join_key_lhs, $this->join_key_rhs);
 537
 538         //Roles can allow for multiple links between two records with different roles
 539         if (!empty($this->def['relationship_role_column']) && !$this->ignore_role_filter)
 540         {
 541             $fields[] = $this->relationship_role_column;
 542         }
 543
 544         return $fields;
 545     }
 546
 547     public function getRelationshipTable()
 548     {
 549         if (!empty($this->def['table']))
 550             return $this->def['table'];
 551         else if(!empty($this->def['join_table']))
 552             return $this->def['join_table'];
 553
 554         return false;
 555     }
 556
 557     public function getFields()
 558     {
 559         if (!empty($this->def['fields']))
 560             return $this->def['fields'];
 561         $fields = array(
 562             "id" => array('name' => 'id'),
 563             'date_modified' => array('name' => 'date_modified'),
 564             'modified_user_id' => array('name' => 'modified_user_id'),
 565             'created_by' => array('name' => 'created_by'),
 566             $this->def['join_key_lhs'] => array('name' => $this->def['join_key_lhs']),
 567             $this->def['join_key_rhs'] => array('name' => $this->def['join_key_rhs'])
 568         );
 569         if (!empty($this->def['relationship_role_column']))
 570         {
 571             $fields[$this->def['relationship_role_column']] = array("name" => $this->def['relationship_role_column']);
 572         }
 573         $fields['deleted'] = array('name' => 'deleted');
 574
 575         return $fields;
 576     }
 577
 578 }