FOSSology  4.5.1
Open Source License Compliance by Open Source Software
DeciderAgentPlugin.php
1 <?php
2 /*
3  SPDX-FileCopyrightText: © 2014-2018 Siemens AG
4 
5 
6  SPDX-License-Identifier: GPL-2.0-only
7 */
8 
10 use Symfony\Component\HttpFoundation\Request;
11 
12 include_once(__DIR__ . "/../agent/version.php");
13 
19 {
20  const RULES_FLAG = "-r";
21  const LICENSE_FLAG = "-t";
22 
23  function __construct()
24  {
25  $this->Name = "agent_decider";
26  $this->Title = _("Automatic Concluded License Decider, based on scanners Matches");
27  $this->AgentName = AGENT_DECIDER_NAME;
28 
29  parent::__construct();
30  }
31 
32 
38  public function renderContent(&$vars)
39  {
40  global $SysConf;
41  $renderer = $GLOBALS['container']->get('twig.environment');
42  $vars['isNinkaInstalled'] = false;
43  if ($ninkaUi=plugin_find('agent_ninka')) {
44  $vars['isNinkaInstalled'] = $ninkaUi->isNinkaInstalled();
45  }
46  $vars['isSpacyInstalled'] = $this->isSpacyInstalled();
47  $licenseTypes = array_map('trim', explode(',',
48  $SysConf['SYSCONFIG']['LicenseTypes']));
49  $vars['licenseTypes'] = array_combine($licenseTypes, $licenseTypes);
50  return $renderer->load('agent_decider.html.twig')->render($vars);
51  }
52 
58  public function renderFoot(&$vars)
59  {
60  return "";
61  }
62 
71  public function scheduleAgent($jobId, $uploadId, &$errorMsg, $request)
72  {
73  $dependencies = array();
74 
75  $rules = $request->get('deciderRules', []);
76  $agents = $request->get('agents', []);
77  if (in_array('agent_nomos', $agents)) {
78  $checkAgentNomos = true;
79  } else {
80  $checkAgentNomos = $request->get('Check_agent_nomos', false);
81  }
82 
83  if (in_array('agent_copyright', $agents)) {
84  $checkAgentCopyright = true;
85  } else {
86  $checkAgentCopyright = $request->get('Check_agent_copyright') ?: false;
87  }
88  $rulebits = 0;
89 
90  foreach ($rules as $rule) {
91  switch ($rule) {
92  case 'nomosInMonk':
93  $dependencies[] = 'agent_nomos';
94  $dependencies[] = 'agent_monk';
95  $rulebits |= 0x1;
96  break;
97  case 'nomosMonkNinka':
98  $dependencies[] = 'agent_nomos';
99  $dependencies[] = 'agent_monk';
100  $dependencies[] = 'agent_ninka';
101  $rulebits |= 0x2;
102  break;
103  case 'reuseBulk':
104  $dependencies[] = 'agent_nomos';
105  $dependencies[] = 'agent_monk';
106  $dependencies[] = 'agent_reuser';
107  $rulebits |= 0x4;
108  break;
109  case 'wipScannerUpdates':
110  $this->addScannerDependencies($dependencies, $request);
111  $rulebits |= 0x8;
112  break;
113  case 'ojoNoContradiction':
114  if ($checkAgentNomos) {
115  $dependencies[] = 'agent_nomos';
116  }
117  $dependencies[] = 'agent_ojo';
118  $rulebits |= 0x10;
119  break;
120  case 'copyrightDeactivation':
121  if ($checkAgentCopyright) {
122  $dependencies[] = 'agent_copyright';
123  }
124  $rulebits |= 0x20;
125  break;
126  case 'copyrightDeactivationClutterRemoval':
127  if ($checkAgentCopyright) {
128  $dependencies[] = 'agent_copyright';
129  }
130  $rulebits |= 0x40;
131  break;
132  case 'licenseTypeConc':
133  $dependencies[] = 'agent_compatibility';
134  $rulebits |= 0x80;
135  break;
136  }
137  }
138 
139  if (empty($rulebits)) {
140  return 0;
141  }
142 
143  $args = self::RULES_FLAG . $rulebits;
144 
145  if ($rulebits & 0x80) {
146  $licenseType = $this->getLicenseTypeConf($request);
147  if ($licenseType != "") {
148  $args .= " " . self::LICENSE_FLAG . escapeshellarg($licenseType);
149  }
150  }
151 
152  return parent::AgentAdd($jobId, $uploadId, $errorMsg,
153  array_unique($dependencies), $args, $request);
154  }
155 
161  protected function addScannerDependencies(&$dependencies, Request $request)
162  {
163  $agentList = $request->get('agents') ?: array();
164  foreach (array('agent_nomos', 'agent_monk', 'agent_ninka') as $agentName) {
165  if (in_array($agentName, $dependencies)) {
166  continue;
167  }
168  if ($request->get('Check_'.$agentName)) {
169  $dependencies[] = $agentName;
170  continue;
171  }
172  if (in_array($agentName, $agentList)) {
173  $dependencies[] = $agentName;
174  }
175  }
176  }
177 
182  public function preInstall()
183  {
184  menu_insert("ParmAgents::" . $this->Title, 0, $this->Name);
185  }
186 
192  private function getLicenseTypeConf(Request $request)
193  {
194  global $SysConf;
195  $licenseTypes = array_map('trim', explode(',',
196  $SysConf['SYSCONFIG']['LicenseTypes']));
197  $licenseType = trim($request->get("licenseTypeConc", ""));
198  if (in_array($licenseType, $licenseTypes)) {
199  return $licenseType;
200  }
201  return "";
202  }
203 
208  public function isSpacyInstalled()
209  {
210  global $SysConf;
211  return file_exists("/home/" .
212  $SysConf['DIRECTORIES']['PROJECTUSER'] . "/pythondeps/bin/spacy");
213  }
214 }
215 
216 register_plugin(new DeciderAgentPlugin());
UI plugin for DeciderAgent.
renderFoot(&$vars)
Render footer HTML.
addScannerDependencies(&$dependencies, Request $request)
Add dependencies on DeciderAgent.
getLicenseTypeConf(Request $request)
scheduleAgent($jobId, $uploadId, &$errorMsg, $request)
Schedule decider agent.
renderContent(&$vars)
Render HTML from template.
menu_insert($Path, $LastOrder=0, $URI=NULL, $Title=NULL, $Target=NULL, $HTML=NULL)
Given a Path, order level for the last item, and optional plugin name, insert the menu item.
plugin_find($pluginName)
Given the official name of a plugin, return the $Plugins object.
char * trim(char *ptext)
Trimming whitespace.
Definition: fossconfig.c:690