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
 165     protected function getRowToInsert($lhs, $rhs, $additionalFields = array())
 166     {
 167         $row = array(
 168             "id" => create_guid(),
 169             $this->def['join_key_lhs'] => $lhs->id,
 170             $this->def['join_key_rhs'] => $rhs->id,
 171             'date_modified' => TimeDate::getInstance()->nowDb(),
 172             'deleted' => 0,
 173         );
 174
 175
 176         if (!empty($this->def['relationship_role_column']) && !empty($this->def['relationship_role_column_value']) && !$this->ignore_role_filter )
 177         {
 178             $row[$this->relationship_role_column] = $this->relationship_role_column_value;
 179         }
 180
 181         if (!empty($this->def['fields']))
 182         {
 183             foreach($this->def['fields'] as $fieldDef)
 184             {
 185                 if (!empty($fieldDef['name']) && !isset($row[$fieldDef['name']]) && !empty($fieldDef['default']))
 186                 {
 187                     $row[$fieldDef['name']] = $fieldDef['default'];
 188                 }
 189             }
 190         }
 191         if (!empty($additionalFields))
 192         {
 193             $row = array_merge($row, $additionalFields);
 194         }
 195
 196         return $row;
 197     }
 198
 199     /**
 200      * Adds the reversed version of this relationship to the table so that it can be accessed from either side equally
 201      * @param $lhs
 202      * @param $rhs
 203      * @param array $additionalFields
 204      * @return void
 205      */
 206     protected function addSelfReferencing($lhs, $rhs, $additionalFields = array())
 207     {
 208         if ($rhs->id != $lhs->id)
 209         {
 210             $dataToInsert = $this->getRowToInsert($rhs, $lhs, $additionalFields);
 211             $this->addRow($dataToInsert);
 212         }
 213     }
 214
 215     public function remove($lhs, $rhs)
 216     {
 217         if(!($lhs instanceof SugarBean) || !($rhs instanceof SugarBean)) {
 218             $GLOBALS['log']->fatal("LHS and RHS must be beans");
 219             return false;
 220         }
 221         $lhsLinkName = $this->lhsLink;
 222         $rhsLinkName = $this->rhsLink;
 223
 224         if (!($lhs instanceof SugarBean)) {
 225             $GLOBALS['log']->fatal("LHS is not a SugarBean object");
 226             return false;
 227         }
 228         if (!($rhs instanceof SugarBean)) {
 229             $GLOBALS['log']->fatal("RHS is not a SugarBean object");
 230             return false;
 231         }
 232         if (empty($lhs->$lhsLinkName) && !$lhs->load_relationship($lhsLinkName))
 233         {
 234             $GLOBALS['log']->fatal("could not load LHS $lhsLinkName");
 235             return false;
 236         }
 237         if (empty($rhs->$rhsLinkName) && !$rhs->load_relationship($rhsLinkName))
 238         {
 239             $GLOBALS['log']->fatal("could not load RHS $rhsLinkName");
 240             return false;
 241         }
 242
 243         if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
 244         {
 245             if ($lhs->$lhsLinkName instanceof Link2)
 246             {
 247                 $lhs->$lhsLinkName->load();
 248                 $this->callBeforeDelete($lhs, $rhs, $lhsLinkName);
 249             }
 250
 251             if ($rhs->$rhsLinkName instanceof Link2)
 252             {
 253                 $rhs->$rhsLinkName->load();
 254                 $this->callBeforeDelete($rhs, $lhs, $rhsLinkName);
 255             }
 256         }
 257
 258         $dataToRemove = array(
 259             $this->def['join_key_lhs'] => $lhs->id,
 260             $this->def['join_key_rhs'] => $rhs->id
 261         );
 262
 263         $this->removeRow($dataToRemove);
 264
 265         if ($this->self_referencing)
 266             $this->removeSelfReferencing($lhs, $rhs);
 267
 268         if (empty($_SESSION['disable_workflow']) || $_SESSION['disable_workflow'] != "Yes")
 269         {
 270             if ($lhs->$lhsLinkName instanceof Link2)
 271             {
 272                 $lhs->$lhsLinkName->load();
 273                 $this->callAfterDelete($lhs, $rhs, $lhsLinkName);
 274             }
 275
 276             if ($rhs->$rhsLinkName instanceof Link2)
 277             {
 278                 $rhs->$rhsLinkName->load();
 279                 $this->callAfterDelete($rhs, $lhs, $rhsLinkName);
 280             }
 281         }
 282     }
 283
 284     /**
 285      * Removes the reversed version of this relationship
 286      * @param $lhs
 287      * @param $rhs
 288      * @param array $additionalFields
 289      * @return void
 290      */
 291     protected function removeSelfReferencing($lhs, $rhs, $additionalFields = array())
 292     {
 293         if ($rhs->id != $lhs->id)
 294         {
 295             $dataToRemove = array(
 296                 $this->def['join_key_lhs'] => $rhs->id,
 297                 $this->def['join_key_rhs'] => $lhs->id
 298             );
 299             $this->removeRow($dataToRemove);
 300         }
 301     }
 302
 303     /**
 304      * @param  $link Link2 loads the relationship for this link.
 305      * @return void
 306      */
 307     public function load($link, $params = array())
 308     {
 309         $db = DBManagerFactory::getInstance();
 310         $query = $this->getQuery($link, $params);
 311         $result = $db->query($query);
 312         $rows = Array();
 313         $idField = $link->getSide() == REL_LHS ? $this->def['join_key_rhs'] : $this->def['join_key_lhs'];
 314         while ($row = $db->fetchByAssoc($result, FALSE))
 315         {
 316             if (empty($row['id']) && empty($row[$idField]))
 317                 continue;
 318             $id = empty($row['id']) ? $row[$idField] : $row['id'];
 319             $rows[$id] = $row;
 320         }
 321         return array("rows" => $rows);
 322     }
 323
 324     protected function linkIsLHS($link) {
 325         return $link->getSide() == REL_LHS;
 326     }
 327
 328     public function getQuery($link, $params = array())
 329     {
 330         if ($this->linkIsLHS($link)) {
 331             $knownKey = $this->def['join_key_lhs'];
 332             $targetKey = $this->def['join_key_rhs'];
 333             $relatedSeed = BeanFactory::getBean($this->getRHSModule());
 334             if (!empty($params['where']))
 335                 $whereTable = (empty($params['right_join_table_alias']) ? $relatedSeed->table_name : $params['right_join_table_alias']);
 336         }
 337         else
 338         {
 339             $knownKey = $this->def['join_key_rhs'];
 340             $targetKey = $this->def['join_key_lhs'];
 341             $relatedSeed = BeanFactory::getBean($this->getLHSModule());
 342             if (!empty($params['where']))
 343                 $whereTable = (empty($params['left_join_table_alias']) ? $relatedSeed->table_name : $params['left_join_table_alias']);
 344         }
 345         $rel_table = $this->getRelationshipTable();
 346
 347         $where = "$rel_table.$knownKey = '{$link->getFocus()->id}'" . $this->getRoleWhere();
 348
 349         //Add any optional where clause
 350         if (!empty($params['where'])){
 351             $add_where = is_string($params['where']) ? $params['where'] : "$whereTable." . $this->getOptionalWhereClause($params['where']);
 352             if (!empty($add_where))
 353                 $where .= " AND $rel_table.$targetKey=$whereTable.id AND $add_where";
 354         }
 355
 356         $deleted = !empty($params['deleted']) ? 1 : 0;
 357         $from = $rel_table;
 358         if (!empty($params['where']))
 359             $from .= ", $whereTable";
 360
 361         if (empty($params['return_as_array'])) {
 362             $query = "SELECT $targetKey id FROM $from WHERE $where AND $rel_table.deleted=$deleted";
 363             //Limit is not compatible with return_as_array
 364             if (!empty($params['limit']) && $params['limit'] > 0) {
 365                 $offset = isset($params['offset']) ? $params['offset'] : 0;
 366                 $query = DBManagerFactory::getInstance()->limitQuery($query, $offset, $params['limit'], false, "", false);
 367             }
 368             return $query;
 369         }
 370         else
 371         {
 372             return array(
 373                 'select' => "SELECT $targetKey id",
 374                 'from' => "FROM $from",
 375                 'where' => "WHERE $where AND $rel_table.deleted=$deleted",
 376             );
 377         }
 378     }
 379
 380     public function getJoin($link, $params = array(), $return_array = false)
 381     {
 382         $linkIsLHS = $link->getSide() == REL_LHS;
 383         if ($linkIsLHS) {
 384             $startingTable = (empty($params['left_join_table_alias']) ? $link->getFocus()->table_name : $params['left_join_table_alias']);
 385         } else {
 386             $startingTable = (empty($params['right_join_table_alias']) ? $link->getFocus()->table_name : $params['right_join_table_alias']);
 387         }
 388
 389         $startingKey = $linkIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
 390         $startingJoinKey = $linkIsLHS ? $this->def['join_key_lhs'] : $this->def['join_key_rhs'];
 391         $joinTable = $this->getRelationshipTable();
 392         $joinTableWithAlias = $joinTable;
 393         $joinKey = $linkIsLHS ? $this->def['join_key_rhs'] : $this->def['join_key_lhs'];
 394         $targetTable = $linkIsLHS ? $this->def['rhs_table'] : $this->def['lhs_table'];
 395         $targetTableWithAlias = $targetTable;
 396         $targetKey = $linkIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
 397         $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
 398
 399         $join = '';
 400
 401         //Set up any table aliases required
 402         if (!empty($params['join_table_link_alias']))
 403         {
 404             $joinTableWithAlias = $joinTable . " ". $params['join_table_link_alias'];
 405             $joinTable = $params['join_table_link_alias'];
 406         }
 407         if ( ! empty($params['join_table_alias']))
 408         {
 409             $targetTableWithAlias = $targetTable . " ". $params['join_table_alias'];
 410             $targetTable = $params['join_table_alias'];
 411         }
 412
 413         $join1 = "$startingTable.$startingKey=$joinTable.$startingJoinKey";
 414         $join2 = "$targetTable.$targetKey=$joinTable.$joinKey";
 415         $where = "";
 416
 417
 418         //First join the relationship table
 419         $join .= "$join_type $joinTableWithAlias ON $join1 AND $joinTable.deleted=0\n"
 420         //Next add any role filters
 421                . $this->getRoleWhere($joinTable) . "\n"
 422         //Then finally join the related module's table
 423                . "$join_type $targetTableWithAlias ON $join2 AND $targetTable.deleted=0\n";
 424
 425         if($return_array){
 426             return array(
 427                 'join' => $join,
 428                 'type' => $this->type,
 429                 'rel_key' => $joinKey,
 430                 'join_tables' => array($joinTable, $targetTable),
 431                 'where' => $where,
 432                 'select' => "$targetTable.id",
 433             );
 434         }
 435         return $join . $where;
 436     }
 437
 438     /**
 439      * Similar to getQuery or Get join, except this time we are starting from the related table and
 440      * searching for items with id's matching the $link->focus->id
 441      * @param  $link
 442      * @param array $params
 443      * @param bool $return_array
 444      * @return String|Array
 445      */
 446     public function getSubpanelQuery($link, $params = array(), $return_array = false)
 447     {
 448         $targetIsLHS = $link->getSide() == REL_RHS;
 449         $startingTable = $targetIsLHS ? $this->def['lhs_table'] : $this->def['rhs_table'];;
 450         $startingKey = $targetIsLHS ? $this->def['lhs_key'] : $this->def['rhs_key'];
 451         $startingJoinKey = $targetIsLHS ? $this->def['join_key_lhs'] : $this->def['join_key_rhs'];
 452         $joinTable = $this->getRelationshipTable();
 453         $joinTableWithAlias = $joinTable;
 454         $joinKey = $targetIsLHS ? $this->def['join_key_rhs'] : $this->def['join_key_lhs'];
 455         $targetKey = $targetIsLHS ? $this->def['rhs_key'] : $this->def['lhs_key'];
 456         $join_type= isset($params['join_type']) ? $params['join_type'] : ' INNER JOIN ';
 457
 458         $query = '';
 459
 460         //Set up any table aliases required
 461         if (!empty($params['join_table_link_alias']))
 462         {
 463             $joinTableWithAlias = $joinTable . " ". $params['join_table_link_alias'];
 464             $joinTable = $params['join_table_link_alias'];
 465         }
 466
 467         $where = "$startingTable.$startingKey=$joinTable.$startingJoinKey AND $joinTable.$joinKey='{$link->getFocus()->$targetKey}'";
 468
 469         //Check if we should ignore the role filter.
 470         $ignoreRole = !empty($params['ignore_role']);
 471
 472         //First join the relationship table
 473         $query .= "$join_type $joinTableWithAlias ON $where AND $joinTable.deleted=0\n"
 474         //Next add any role filters
 475                . $this->getRoleWhere($joinTable, $ignoreRole) . "\n";
 476
 477         if (!empty($params['return_as_array'])) {
 478             $return_array = true;
 479         }
 480         if($return_array){
 481             return array(
 482                 'join' => $query,
 483                 'type' => $this->type,
 484                 'rel_key' => $joinKey,
 485                 'join_tables' => array($joinTable),
 486                 'where' => "",
 487                 'select' => " ",
 488             );
 489         }
 490         return $query;
 491
 492     }
 493
 494     protected function getRoleFilterForJoin()
 495     {
 496         $ret = "";
 497         if (!empty($this->relationship_role_column) && !$this->ignore_role_filter)
 498         {
 499             $ret .= " AND ".$this->getRelationshipTable().'.'.$this->relationship_role_column;
 500             //role column value.
 501             if (empty($this->relationship_role_column_value))
 502             {
 503                 $ret.=' IS NULL';
 504             } else {
 505                 $ret.= "='".$this->relationship_role_column_value."'";
 506             }
 507             $ret.= "\n";
 508         }
 509         return $ret;
 510     }
 511
 512     /**
 513      * @param  $lhs
 514      * @param  $rhs
 515      * @return bool
 516      */
 517     public function relationship_exists($lhs, $rhs)
 518     {
 519         $query = "SELECT id FROM {$this->getRelationshipTable()} WHERE {$this->join_key_lhs} = '{$lhs->id}' AND {$this->join_key_rhs} = '{$rhs->id}'";
 520
 521         //Roles can allow for multiple links between two records with different roles
 522         $query .= $this->getRoleWhere() . " and deleted = 0";
 523
 524         return $GLOBALS['db']->getOne($query);
 525     }
 526
 527     /**
 528      * @return Array - set of fields that uniquely identify an entry in this relationship
 529      */
 530     protected function getAlternateKeyFields()
 531     {
 532         $fields = array($this->join_key_lhs, $this->join_key_rhs);
 533
 534         //Roles can allow for multiple links between two records with different roles
 535         if (!empty($this->def['relationship_role_column']) && !$this->ignore_role_filter)
 536         {
 537             $fields[] = $this->relationship_role_column;
 538         }
 539
 540         return $fields;
 541     }
 542
 543     public function getRelationshipTable()
 544     {
 545         if (!empty($this->def['table']))
 546             return $this->def['table'];
 547         else if(!empty($this->def['join_table']))
 548             return $this->def['join_table'];
 549
 550         return false;
 551     }
 552
 553     public function getFields()
 554     {
 555         if (!empty($this->def['fields']))
 556             return $this->def['fields'];
 557         $fields = array(
 558             "id" => array('name' => 'id'),
 559             'date_modified' => array('name' => 'date_modified'),
 560             'modified_user_id' => array('name' => 'modified_user_id'),
 561             'created_by' => array('name' => 'created_by'),
 562             $this->def['join_key_lhs'] => array('name' => $this->def['join_key_lhs']),
 563             $this->def['join_key_rhs'] => array('name' => $this->def['join_key_rhs'])
 564         );
 565         if (!empty($this->def['relationship_role_column']))
 566         {
 567             $fields[$this->def['relationship_role_column']] = array("name" => $this->def['relationship_role_column']);
 568         }
 569         $fields['deleted'] = array('name' => 'deleted');
 570
 571         return $fields;
 572     }
 573
 574 }