Class: Yast::WorkflowManagerClass
- Inherits:
-
Module
- Object
- Module
- Yast::WorkflowManagerClass
- Defined in:
- ../../src/modules/WorkflowManager.rb
Instance Method Summary (collapse)
-
- (Boolean) AddNewProposals(proposals)
Add new defined proposal to the list of system proposals.
-
- (Boolean) AddWorkflow(type, src_id, name)
Stores new workflow (if such workflow exists) into the Worflow Store.
-
- (Object) CleanWorkflowsDirectory
Removes all xml and ycp files from directory where.
-
- (Hash{String => Object}) DumpCurrentSettings
Returns the current settings used by WorkflowManager.
-
- (Object) FillUpInitialWorkflowSettings
Fills the workflow with initial settings to start merging from scratch.
-
- (String) GenerateAdditionalControlFilePath(src_id, ident)
Creates path to a control file from parameters.
-
- (String) GenerateWorkflowIdent(workflow_filename)
Returns file unique identification in format $file_MD5sum-$file_size Returns 'nil' if file doesn't exist, it is not a 'file', etc.
-
- (Array<String>) GetAdditionalFinishSteps(which_steps)
Returns list of additional inst_finish steps requested by additional workflows.
-
- (Array<String>) GetAllUsedControlFiles
Returns list of control-file names currently used.
-
- (String) GetCachedWorkflowFilename(type, src_id, _name)
Returns requested control filename.
-
- (Object) GetWorkflowDirectory
Returns the current (default) directory where workflows are stored in.
-
- (Boolean) HaveAdditionalWorkflows
Returns whether some additional control files are currently in use.
- - (Object) IncorporateControlFileOptions(filename)
-
- (Boolean) IntegrateWorkflow(filename)
Integrate the changes in the workflow.
- - (Object) main
-
- (Hash) MergeProposal(base, additional_control, prod_name, domain)
Merge add-on proposal to a base proposal.
-
- (Hash) MergeWorkflow(base, addon, _prod_name, domain)
Merge add-on workflow to a base workflow.
-
- (Boolean) MergeWorkflows
Function uses the Base Workflow as the initial one and merges all added workflow into that workflow.
-
- (Array<Hash>) PrepareProposals(proposals)
Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.
-
- (Object) PrepareSystemProposals
Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.
-
- (Object) PrepareSystemWorkflows
Check all workflows, split those ones which have multiple modes or architectures or stages into multiple worlflows.
-
- (Array<Hash>) PrepareWorkflows(workflows)
Check all workflows, split those ones which have multiple modes or architectures or stages into multiple workflows.
-
- (Object) RedrawWizardSteps
Redraws workflow steps.
-
- (Boolean) RemoveWorkflow(type, src_id, name)
Removes workflow (if such workflow exists) from the Worflow Store.
-
- (Object) ReplaceProposalModule(proposal, old, new)
Replace a module in a proposal with a set of other modules.
-
- (Object) ReplaceWorkflowModule(workflow, old, new, domain, keep)
Replace a module in a workflow with a set of other modules.
-
- (Boolean) Replaceworkflows(workflows)
Replace workflows for 2nd stage of installation.
-
- (Object) ResetWorkflow
Resets the Workflow (and proposals) to use the base workflow.
-
- (Object) SetAllUsedControlFiles(new_list)
Sets list of control-file names to be used.
-
- (Object) SetBaseWorkflow(force)
Stores the current ProductControl settings as the initial settings.
-
- (Object) SomeWorkflowsWereChanged
Returns whether some additional control files were added or removed from the last time MergeWorkflows() was called.
-
- (String) StoreWorkflowFile(file_from, file_to)
Stores the workflow file to a cache.
-
- (Boolean) UpdateInstallation(update_file, name, domain)
Adapts the current workflow according to specified XML file content.
-
- (Boolean) UpdateInstFinish(additional_steps)
Add specified steps to inst_finish.
-
- (Boolean) UpdateProductInfo(update_file, _filename)
Update product options such as global settings, software, partitioning or network.
-
- (Boolean) UpdateProposals(proposals, prod_name, domain)
Update system proposals according to proposal update metadata.
-
- (Boolean) UpdateWorkflows(workflows, prod_name, domain)
Update system workflows according to workflow update metadata.
-
- (Boolean) WorkflowRequiresRegistration(src_id)
Returns whether a repository workflow requires registration.
-
- (Object) WorkflowsRequiringRegistration
Returns list of workflows requiring registration.
Instance Method Details
- (Boolean) AddNewProposals(proposals)
Add new defined proposal to the list of system proposals
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 |
# File '../../src/modules/WorkflowManager.rb', line 967 def AddNewProposals(proposals) proposals = deep_copy(proposals) forbidden = Builtins.maplist(ProductControl.proposals) do |p| Ops.get_string(p, "name", "") end forbidden = Builtins.toset(forbidden) Builtins.foreach(proposals) do |proposal| if !Builtins.contains(forbidden, Ops.get_string(proposal, "name", "")) Builtins.y2milestone( "Adding new proposal %1", Ops.get_string(proposal, "name", "") ) ProductControl.proposals = Builtins.add( ProductControl.proposals, proposal ) else Builtins.y2warning( "Proposal '%1' already exists, not adding", Ops.get_string(proposal, "name", "") ) end end true end |
- (Boolean) AddWorkflow(type, src_id, name)
Stores new workflow (if such workflow exists) into the Worflow Store.
AddWorkflow (`addon, 4, “”);
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File '../../src/modules/WorkflowManager.rb', line 440 def AddWorkflow(type, src_id, name) Builtins.y2milestone( "Adding Workflow: Type %1, ID %2, Name %3", type, src_id, name ) if !Builtins.contains([:addon, :pattern], type) Builtins.y2error("Unknown workflow type: %1", type) return false end # new xml filename used_filename = nil if type == :addon used_filename = GetCachedWorkflowFilename(:addon, src_id, "") elsif type == :pattern Builtins.y2error("Not implemented yet") return false end if !used_filename.nil? && used_filename != "" @unmerged_changes = true @used_workflows = Builtins.add(@used_workflows, used_filename) Ops.set(@workflows_to_sources, used_filename, src_id) end true end |
- (Object) CleanWorkflowsDirectory
Removes all xml and ycp files from directory where
FIXME: this function seems to be unused, remove it?
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 |
# File '../../src/modules/WorkflowManager.rb', line 536 def CleanWorkflowsDirectory directory = GetWorkflowDirectory() Builtins.y2milestone( "Removing all xml and ycp files from '%1' directory", directory ) if FileUtils.Exists(directory) # doesn't add RPM dependency on tar cmd = Convert.to_map( SCR.Execute( path(".target.bash_ouptut"), "\n" \ "cd '%1';\n" \ "test -x /bin/tar && /bin/tar -zcf workflows_backup.tgz *.xml *.ycp *.rb;\n" \ "rm -rf *.xml *.ycp *.rb", String.Quote(directory) ) ) if Ops.get_integer(cmd, "exit", -1) != 0 Builtins.y2error("Removing failed: %1", cmd) end end nil end |
- (Hash{String => Object}) DumpCurrentSettings
Returns the current settings used by WorkflowManager. This function is just for debugging purpose.
Structure:
[
"workflows" : ...
"proposals" : ...
"inst_finish" : ...
"clone_modules" : ...
"unmerged_changes" : ...
];
1378 1379 1380 1381 1382 1383 1384 1385 1386 |
# File '../../src/modules/WorkflowManager.rb', line 1378 def DumpCurrentSettings { "workflows" => ProductControl.workflows, "proposals" => ProductControl.proposals, "inst_finish" => ProductControl.inst_finish, "clone_modules" => ProductControl.clone_modules, "unmerged_changes" => @unmerged_changes } end |
- (Object) FillUpInitialWorkflowSettings
Fills the workflow with initial settings to start merging from scratch. Used workflows mustn't be cleared automatically, merging would fail!
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File '../../src/modules/WorkflowManager.rb', line 280 def FillUpInitialWorkflowSettings if !@base_workflow_stored Builtins.y2error( "Base Workflow has never been stored, you should have called SetBaseWorkflow() before!" ) end ProductFeatures.Import(@wkf_initial_product_features) ProductControl.workflows = deep_copy(@wkf_initial_workflows) ProductControl.proposals = deep_copy(@wkf_initial_proposals) ProductControl.inst_finish = deep_copy(@wkf_initial_inst_finish) ProductControl.clone_modules = deep_copy(@wkf_initial_clone_modules) @additional_finish_steps_before_chroot = [] @additional_finish_steps_after_chroot = [] @additional_finish_steps_before_umount = [] @workflows_requiring_registration = [] @workflows_to_sources = {} # reset internal variable to force the Prepare... function @system_proposals_prepared = false PrepareSystemProposals() # reset internal variable to force the Prepare... function @system_workflows_prepared = false PrepareSystemWorkflows() nil end |
- (String) GenerateAdditionalControlFilePath(src_id, ident)
Creates path to a control file from parameters. For add-on products, the 'ident' parameter is empty.
332 333 334 335 336 337 |
# File '../../src/modules/WorkflowManager.rb', line 332 def GenerateAdditionalControlFilePath(src_id, ident) # special handling for Add-Ons (they have no special ident) ident = "__AddOnProduct-ControlFile__" if ident == "" Builtins.sformat("%1/%2:%3.xml", GetWorkflowDirectory(), src_id, ident) end |
- (String) GenerateWorkflowIdent(workflow_filename)
Returns file unique identification in format $file_MD5sum-$file_size Returns 'nil' if file doesn't exist, it is not a 'file', etc.
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 |
# File '../../src/modules/WorkflowManager.rb', line 1256 def GenerateWorkflowIdent(workflow_filename) file_md5sum = FileUtils.MD5sum(workflow_filename) if file_md5sum.nil? || file_md5sum == "" Builtins.y2error( "MD5 sum of file %1 is %2", workflow_filename, file_md5sum ) return nil end file_size = FileUtils.GetSize(workflow_filename) if Ops.less_than(file_size, 0) Builtins.y2error("File size %1 is %2", workflow_filename, file_size) return nil end Builtins.sformat("%1-%2", file_md5sum, file_size) end |
- (Array<String>) GetAdditionalFinishSteps(which_steps)
Returns list of additional inst_finish steps requested by additional workflows.
121 122 123 124 125 126 127 128 129 130 131 132 |
# File '../../src/modules/WorkflowManager.rb', line 121 def GetAdditionalFinishSteps(which_steps) if which_steps == "before_chroot" return deep_copy(@additional_finish_steps_before_chroot) elsif which_steps == "after_chroot" return deep_copy(@additional_finish_steps_after_chroot) elsif which_steps == "before_umount" return deep_copy(@additional_finish_steps_before_umount) else Builtins.y2error("Unknown FinishSteps type: %1", which_steps) return nil end end |
- (Array<String>) GetAllUsedControlFiles
Returns list of control-file names currently used
1337 1338 1339 |
# File '../../src/modules/WorkflowManager.rb', line 1337 def GetAllUsedControlFiles deep_copy(@used_workflows) end |
- (String) GetCachedWorkflowFilename(type, src_id, _name)
Returns requested control filename. Parameter 'name' is ignored for Add-Ons.
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File '../../src/modules/WorkflowManager.rb', line 395 def GetCachedWorkflowFilename(type, src_id, _name) if type == :addon disk_filename = GenerateAdditionalControlFilePath(src_id, "") # A cached copy exists if FileUtils.Exists(disk_filename) Builtins.y2milestone("Using cached file %1", disk_filename) return disk_filename # Trying to get the file from source else Builtins.y2milestone("File %1 not cached", disk_filename) # using a file from source use_filename = Pkg.SourceProvideDigestedFile( src_id, 1, "/installation.xml", true ) # File exists if !use_filename.nil? return StoreWorkflowFile(use_filename, disk_filename) # No such file else return nil end end # New workflow types can be added here else Builtins.y2error("Unknown workflow type: %1", type) return nil end end |
- (Object) GetWorkflowDirectory
Returns the current (default) directory where workflows are stored in.
322 323 324 |
# File '../../src/modules/WorkflowManager.rb', line 322 def GetWorkflowDirectory Builtins.sformat("%1/%2", Directory.tmpdir, @control_files_dir) end |
- (Boolean) HaveAdditionalWorkflows
Returns whether some additional control files are currently in use.
1360 1361 1362 |
# File '../../src/modules/WorkflowManager.rb', line 1360 def HaveAdditionalWorkflows Ops.greater_or_equal(Builtins.size(GetAllUsedControlFiles()), 0) end |
- (Object) IncorporateControlFileOptions(filename)
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 |
# File '../../src/modules/WorkflowManager.rb', line 1099 def IncorporateControlFileOptions(filename) update_file = XML.XMLToYCPFile(filename) if update_file.nil? Builtins.y2error("Unable to read the %1 control file", filename) return false end # FATE #305578: Add-On Product Requiring Registration globals = Ops.get_map(update_file, "globals", {}) if Builtins.haskey(globals, "require_registration") && Ops.get_boolean(globals, "require_registration", false) == true Builtins.y2milestone("Registration is required by %1", filename) @workflows_requiring_registration = Builtins.toset( Builtins.add(@workflows_requiring_registration, filename) ) Builtins.y2milestone( "Workflows requiring registration: %1", @workflows_requiring_registration ) else Builtins.y2milestone("Registration is not required by %1", filename) end true end |
- (Boolean) IntegrateWorkflow(filename)
Integrate the changes in the workflow
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 |
# File '../../src/modules/WorkflowManager.rb', line 1211 def IntegrateWorkflow(filename) Builtins.y2milestone("IntegrateWorkflow %1", filename) update_file = XML.XMLToYCPFile(filename) name = Ops.get_string(update_file, "display_name", "") if !UpdateInstallation( Ops.get_map(update_file, "update", {}), name, Ops.get_string(update_file, "textdomain", "control") ) Builtins.y2error("Failed to update installation workflow") return false end if !UpdateProductInfo(update_file, filename) Builtins.y2error("Failed to set product options") return false end if !AddNewProposals(Ops.get_list(update_file, "proposals", [])) Builtins.y2error("Failed to add new proposals") return false end if !Replaceworkflows(Ops.get_list(update_file, "workflows", [])) Builtins.y2error("Failed to replace workflows") return false end if !UpdateInstFinish( Ops.get_map(update_file, ["update", "inst_finish"], {}) ) Builtins.y2error("Adding inst_finish steps failed") return false end true end |
- (Object) main
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File '../../src/modules/WorkflowManager.rb', line 42 def main Yast.import "UI" Yast.import "Pkg" textdomain "base" Yast.import "ProductControl" Yast.import "ProductFeatures" Yast.import "Label" Yast.import "Wizard" Yast.import "Directory" Yast.import "FileUtils" Yast.import "Stage" Yast.import "String" Yast.import "XML" Yast.import "Report" # # This API uses some new terms that need to be explained: # # * Workflow Store # - Kind of database of installation or configuration workflows # # * Base Workflow # - The initial workflow defined by the base product # - In case of running system, this will be probably empty # # * Additional Workflow # - Any workflow defined by Add-On or Pattern in installation # or Pattern in running system # # * Final Workflow # - Workflow that contains the base workflow modified by all # additional workflows # # Base Workflow Store @wkf_initial_workflows = [] @wkf_initial_proposals = [] @wkf_initial_inst_finish = [] @wkf_initial_clone_modules = [] @wkf_initial_product_features = {} # Additional inst_finish settings defined by additional control files. # They are always empty at the begining. @additional_finish_steps_before_chroot = [] @additional_finish_steps_after_chroot = [] @additional_finish_steps_before_umount = [] # FATE #305578: Add-On Product Requiring Registration # $[ "workflow filename" : (boolean) require_registration ] @workflows_requiring_registration = [] @workflows_to_sources = {} @base_workflow_stored = false # Contains all currently workflows added to the Workflow Store @used_workflows = [] # Some workflow changes need merging @unmerged_changes = false # Have system proposals already been prepared for merging? @system_proposals_prepared = false # Have system workflows already been prepared for merging? @system_workflows_prepared = false @control_files_dir = "additional-control-files" end |
- (Hash) MergeProposal(base, additional_control, prod_name, domain)
Merge add-on proposal to a base proposal
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
# File '../../src/modules/WorkflowManager.rb', line 628 def MergeProposal(base, additional_control, prod_name, domain) base = deep_copy(base) additional_control = deep_copy(additional_control) # Additional proposal settings - Replacing items replaces = Builtins.listmap( Ops.get_list(additional_control, "replace_modules", []) ) do |one_addon| old = Ops.get_string(one_addon, "replace", "") new = Ops.get_list(one_addon, "modules", []) { old => new } end Builtins.foreach(replaces) do |old, new| base = ReplaceProposalModule(base, old, new) end if Ops.greater_than( Builtins.size(replaces), 0 ) # Additional proposal settings - Removing settings removes = Ops.get_list(additional_control, "remove_modules", []) Builtins.foreach(removes) { |r| base = ReplaceProposalModule(base, r, []) } if Ops.greater_than( Builtins.size(removes), 0 ) # Additional proposal settings - - Appending settings appends = Ops.get_list(additional_control, "append_modules", []) if Ops.greater_than(Builtins.size(appends), 0) append2 = deep_copy(appends) if Ops.is_map?(Ops.get(base, ["proposal_modules", 0])) append2 = Builtins.maplist(appends) do |m| { "name" => m, "presentation_order" => 9999 } end end Ops.set( base, "proposal_modules", Builtins.merge(Ops.get_list(base, "proposal_modules", []), append2) ) if Builtins.haskey(base, "proposal_tabs") new_tab = { "label" => prod_name, "proposal_modules" => appends, "textdomain" => domain } Ops.set( base, "proposal_tabs", Builtins.add(Ops.get_list(base, "proposal_tabs", []), new_tab) ) end end if Ops.get_string(additional_control, "enable_skip", "yes") == "no" Ops.set(base, "enable_skip", "no") end deep_copy(base) end |
- (Hash) MergeWorkflow(base, addon, _prod_name, domain)
Merge add-on workflow to a base workflow
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 |
# File '../../src/modules/WorkflowManager.rb', line 792 def MergeWorkflow(base, addon, _prod_name, domain) base = deep_copy(base) addon = deep_copy(addon) # Merging - removing steps, settings removes = Ops.get_list(addon, "remove_modules", []) if Ops.greater_than(Builtins.size(removes), 0) Builtins.y2milestone("Remove: %1", removes) Builtins.foreach(removes) do |r| base = ReplaceWorkflowModule(base, r, [], domain, false) end end # Merging - replacing steps, settings replaces = Builtins.listmap(Ops.get_list(addon, "replace_modules", [])) do |a| old = Ops.get_string(a, "replace", "") new = Ops.get_list(a, "modules", []) { old => new } end if Ops.greater_than(Builtins.size(replaces), 0) Builtins.y2milestone("Replace: %1", replaces) Builtins.foreach(replaces) do |old, new| base = ReplaceWorkflowModule(base, old, new, domain, false) end end # Merging - inserting steps, settings inserts = Builtins.listmap(Ops.get_list(addon, "insert_modules", [])) do |i| before = Ops.get_string(i, "before", "") new = Ops.get_list(i, "modules", []) { before => new } end if Ops.greater_than(Builtins.size(inserts), 0) Builtins.y2milestone("Insert: %1", inserts) Builtins.foreach(inserts) do |old, new| base = ReplaceWorkflowModule(base, old, new, domain, true) end end # Merging - appending steps, settings appends = Ops.get_list(addon, "append_modules", []) if Ops.greater_than(Builtins.size(appends), 0) Builtins.y2milestone("Append: %1", appends) Builtins.foreach(appends) do |new| Ops.set(new, "textdomain", domain) Ops.set( base, "modules", Builtins.add(Ops.get_list(base, "modules", []), new) ) end end deep_copy(base) end |
- (Boolean) MergeWorkflows
Function uses the Base Workflow as the initial one and merges all added workflow into that workflow.
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 |
# File '../../src/modules/WorkflowManager.rb', line 1282 def MergeWorkflows Builtins.y2milestone("Merging additional control files from scratch...") @unmerged_changes = false # Init the Base Workflow settings FillUpInitialWorkflowSettings() ret = true already_merged_workflows = [] Builtins.foreach(@used_workflows) do |one_workflow| # make sure that every workflow is merged only once # bugzilla #332436 workflow_ident = GenerateWorkflowIdent(one_workflow) if !workflow_ident.nil? && Builtins.contains(already_merged_workflows, workflow_ident) Builtins.y2milestone( "The very same workflow has been already merged, skipping..." ) next elsif !workflow_ident.nil? already_merged_workflows = Builtins.add( already_merged_workflows, workflow_ident ) else Builtins.y2error("Workflow ident is: %1", workflow_ident) end IncorporateControlFileOptions(one_workflow) if !IntegrateWorkflow(one_workflow) Builtins.y2error("Merging '%1' failed!", one_workflow) Report.Error( _( "An internal error occurred when integrating additional workflow." ) ) ret = false end end ret end |
- (Array<Hash>) PrepareProposals(proposals)
Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.
Structure:
Input: [
$["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"initial,firstboot"]
]
Output: [
$["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"initial"]
$["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"firstboot"]
]
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File '../../src/modules/WorkflowManager.rb', line 177 def PrepareProposals(proposals) proposals = deep_copy(proposals) new_proposals = [] # Going through all proposals Builtins.foreach(proposals) do |one_proposal| mode = Ops.get_string(one_proposal, "mode", "") modes = Builtins.splitstring(mode, ",") modes = [""] if Builtins.size(modes) == 0 # Going through all modes in proposal Builtins.foreach(modes) do |one_mode| mp = deep_copy(one_proposal) Ops.set(mp, "mode", one_mode) arch = Ops.get_string(one_proposal, "archs", "") archs = Builtins.splitstring(arch, ",") archs = [""] if Builtins.size(archs) == 0 # Going through all architectures Builtins.foreach(archs) do |one_arch| amp = deep_copy(mp) Ops.set(amp, "archs", one_arch) stage = Ops.get_string(amp, "stage", "") stages = Builtins.splitstring(stage, ",") stages = [""] if Builtins.size(stages) == 0 # Going through all stages Builtins.foreach(stages) do |one_stage| single_proposal = deep_copy(amp) Ops.set(single_proposal, "stage", one_stage) new_proposals = Builtins.add(new_proposals, single_proposal) end end end end deep_copy(new_proposals) end |
- (Object) PrepareSystemProposals
Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals. Works with base product proposals.
216 217 218 219 220 221 222 223 |
# File '../../src/modules/WorkflowManager.rb', line 216 def PrepareSystemProposals return if @system_proposals_prepared ProductControl.proposals = PrepareProposals(ProductControl.proposals) @system_proposals_prepared = true nil end |
- (Object) PrepareSystemWorkflows
Check all workflows, split those ones which have multiple modes or architectures or stages into multiple worlflows. Works with base product workflows.
269 270 271 272 273 274 275 276 |
# File '../../src/modules/WorkflowManager.rb', line 269 def PrepareSystemWorkflows return if @system_workflows_prepared ProductControl.workflows = PrepareWorkflows(ProductControl.workflows) @system_workflows_prepared = true nil end |
- (Array<Hash>) PrepareWorkflows(workflows)
Check all workflows, split those ones which have multiple modes or architectures or stages into multiple workflows
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File '../../src/modules/WorkflowManager.rb', line 229 def PrepareWorkflows(workflows) workflows = deep_copy(workflows) new_workflows = [] # Going through all workflows Builtins.foreach(workflows) do |one_workflow| mode = Ops.get_string(one_workflow, "mode", "") modes = Builtins.splitstring(mode, ",") modes = [""] if Builtins.size(modes) == 0 # Going through all modes Builtins.foreach(modes) do |one_mode| mw = deep_copy(one_workflow) Ops.set(mw, "mode", one_mode) Ops.set(mw, "defaults", Ops.get_map(mw, "defaults", {})) arch = Ops.get_string(mw, ["defaults", "archs"], "") archs = Builtins.splitstring(arch, ",") archs = [""] if Builtins.size(archs) == 0 # Going through all architercures Builtins.foreach(archs) do |one_arch| amw = deep_copy(mw) Ops.set(amw, ["defaults", "archs"], one_arch) stage = Ops.get_string(amw, "stage", "") stages = Builtins.splitstring(stage, ",") stages = [""] if Builtins.size(stages) == 0 # Going through all stages Builtins.foreach(stages) do |one_stage| single_workflow = deep_copy(amw) Ops.set(single_workflow, "stage", one_stage) new_workflows = Builtins.add(new_workflows, single_workflow) end end end end deep_copy(new_workflows) end |
- (Object) RedrawWizardSteps
Redraws workflow steps. Function must be called when steps (or help for steps) are active. It doesn't work in case of active another dialog.
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 |
# File '../../src/modules/WorkflowManager.rb', line 1193 def RedrawWizardSteps Builtins.y2milestone("Retranslating messages, redrawing wizard steps") # Make sure the labels for default function keys are retranslated, too. # Using Label::DefaultFunctionKeyMap() from Label module. UI.SetFunctionKeys(Label.DefaultFunctionKeyMap) # Activate language changes on static part of wizard dialog ProductControl.RetranslateWizardSteps Wizard.RetranslateButtons Wizard.SetFocusToNextButton true end |
- (Boolean) RemoveWorkflow(type, src_id, name)
Removes workflow (if such workflow exists) from the Worflow Store. Alose removes the cached file but in the installation.
RemoveWorkflow (`addon, 4, “”);
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 |
# File '../../src/modules/WorkflowManager.rb', line 483 def RemoveWorkflow(type, src_id, name) Builtins.y2milestone( "Removing Workflow: Type %1, ID %2, Name %3", type, src_id, name ) if !Builtins.contains([:addon, :pattern], type) Builtins.y2error("Unknown workflow type: %1", type) return false end # cached xml file used_filename = nil if type == :addon used_filename = GenerateAdditionalControlFilePath(src_id, "") else Builtins.y2error("Not implemented yet") return false end if !used_filename.nil? && used_filename != "" @unmerged_changes = true @used_workflows = Builtins.filter(@used_workflows) do |one_workflow| one_workflow != used_filename end if Builtins.haskey(@workflows_to_sources, used_filename) @workflows_to_sources = Builtins.remove( @workflows_to_sources, used_filename ) end if !Stage.initial if FileUtils.Exists(used_filename) Builtins.y2milestone( "Removing cached file '%1': %2", used_filename, SCR.Execute(path(".target.remove"), used_filename) ) end end end true end |
- (Object) ReplaceProposalModule(proposal, old, new)
Replace a module in a proposal with a set of other modules
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 |
# File '../../src/modules/WorkflowManager.rb', line 570 def ReplaceProposalModule(proposal, old, new) proposal = deep_copy(proposal) new = deep_copy(new) found = false modules = Builtins.maplist(Ops.get_list(proposal, "proposal_modules", [])) do |m| if Ops.is_string?(m) && Convert.to_string(m) == old || Ops.is_map?(m) && Ops.get_string(Convert.to_map(m), "name", "") == old found = true if Ops.is_map?(m) next Builtins.maplist(new) do |it| Builtins.union(Convert.to_map(m), "name" => it) end else next deep_copy(new) end else next [m] end end if !found Builtins.y2internal("Replace/Remove proposal item %1 not found", old) end Ops.set(proposal, "proposal_modules", Builtins.flatten(modules)) if Builtins.haskey(proposal, "proposal_tabs") Ops.set( proposal, "proposal_tabs", Builtins.maplist(Ops.get_list(proposal, "proposal_tabs", [])) do |tab| modules2 = Builtins.maplist( Ops.get_list(tab, "proposal_modules", []) ) do |m| if m == old next deep_copy(new) else next [m] end end Ops.set(tab, "proposal_modules", Builtins.flatten(modules2)) deep_copy(tab) end ) end deep_copy(proposal) end |
- (Object) ReplaceWorkflowModule(workflow, old, new, domain, keep)
Replace a module in a workflow with a set of other modules
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 |
# File '../../src/modules/WorkflowManager.rb', line 752 def ReplaceWorkflowModule(workflow, old, new, domain, keep) workflow = deep_copy(workflow) new = deep_copy(new) found = false modules = Builtins.maplist(Ops.get_list(workflow, "modules", [])) do |m| if Ops.get_string(m, "name", "") == old new_list = Builtins.maplist(new) do |n| Ops.set(n, "textdomain", domain) deep_copy(n) end found = true new_list = Builtins.add(new_list, m) if keep next deep_copy(new_list) else next [m] end end if !found Builtins.y2internal( "Insert/Replace/Remove workflow module %1 not found", old ) end Ops.set(workflow, "modules", Builtins.flatten(modules)) deep_copy(workflow) end |
- (Boolean) Replaceworkflows(workflows)
Replace workflows for 2nd stage of installation
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 |
# File '../../src/modules/WorkflowManager.rb', line 1000 def Replaceworkflows(workflows) workflows = deep_copy(workflows) workflows = PrepareWorkflows(workflows) # This function doesn't update the current workflow but replaces it. # That's why it is not allowed for the first stage of the installation. workflows = Builtins.filter(workflows) do |workflow| if Ops.get_string(workflow, "stage", "") == "initial" Builtins.y2error( "Attempting to replace 1st stage workflow. This is not possible" ) Builtins.y2milestone("Workflow: %1", workflow) next false end true end sm = {} Builtins.foreach(workflows) do |workflow| Ops.set( sm, Ops.get_string(workflow, "stage", ""), Ops.get(sm, Ops.get_string(workflow, "stage", ""), {}) ) Ops.set( sm, [ Ops.get_string(workflow, "stage", ""), Ops.get_string(workflow, "mode", "") ], true ) [ Ops.get_string(workflow, "stage", ""), Ops.get_string(workflow, "mode", "") ] end Builtins.y2milestone("Existing replace workflows: %1", sm) Builtins.y2milestone( "Workflows before filtering: %1", Builtins.size(ProductControl.workflows) ) ProductControl.workflows = Builtins.filter(ProductControl.workflows) do |w| !Ops.get( sm, [Ops.get_string(w, "stage", ""), Ops.get_string(w, "mode", "")], false ) end Builtins.y2milestone( "Workflows after filtering: %1", Builtins.size(ProductControl.workflows) ) ProductControl.workflows = Convert.convert( Builtins.merge(ProductControl.workflows, workflows), from: "list", to: "list <map>" ) true end |
- (Object) ResetWorkflow
Resets the Workflow (and proposals) to use the base workflow. It must be stored. Clears also all additional workflows.
314 315 316 317 318 319 |
# File '../../src/modules/WorkflowManager.rb', line 314 def ResetWorkflow FillUpInitialWorkflowSettings() @used_workflows = [] nil end |
- (Object) SetAllUsedControlFiles(new_list)
Sets list of control-file names to be used. ATTENTION: this is dangerous and should be used in rare cases only!
SetAllUsedControlFiles ([“/tmp/new_addon_control.xml”, “/root/special_addon.xml”]);
1348 1349 1350 1351 1352 1353 1354 1355 |
# File '../../src/modules/WorkflowManager.rb', line 1348 def SetAllUsedControlFiles(new_list) new_list = deep_copy(new_list) Builtins.y2milestone("New list of additional workflows: %1", new_list) @unmerged_changes = true @used_workflows = deep_copy(new_list) nil end |
- (Object) SetBaseWorkflow(force)
Stores the current ProductControl settings as the initial settings. These settings are: workflows, proposals, inst_finish, and clone_modules.
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File '../../src/modules/WorkflowManager.rb', line 138 def SetBaseWorkflow(force) if @base_workflow_stored && !force Builtins.y2milestone("Base Workflow has been already set") return end @wkf_initial_product_features = ProductFeatures.Export @wkf_initial_workflows = deep_copy(ProductControl.workflows) @wkf_initial_proposals = deep_copy(ProductControl.proposals) @wkf_initial_inst_finish = deep_copy(ProductControl.inst_finish) @wkf_initial_clone_modules = deep_copy(ProductControl.clone_modules) @additional_finish_steps_before_chroot = [] @additional_finish_steps_after_chroot = [] @additional_finish_steps_before_umount = [] @base_workflow_stored = true nil end |
- (Object) SomeWorkflowsWereChanged
Returns whether some additional control files were added or removed from the last time MergeWorkflows() was called.
1330 1331 1332 |
# File '../../src/modules/WorkflowManager.rb', line 1330 def SomeWorkflowsWereChanged @unmerged_changes end |
- (String) StoreWorkflowFile(file_from, file_to)
Stores the workflow file to a cache
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File '../../src/modules/WorkflowManager.rb', line 344 def StoreWorkflowFile(file_from, file_to) if file_from.nil? || file_from == "" || file_to.nil? || file_to == "" Builtins.y2error("Cannot copy '%1' to '%2'", file_from, file_to) return nil end # Return nil if cannot copy file_location = nil Builtins.y2milestone( "Copying workflow from '%1' to '%2'", file_from, file_to ) cmd = Convert.to_map( SCR.Execute( path(".target.bash_output"), Builtins.sformat( "\n" \ "test -d '%1' || /bin/mkdir -p '%1';\n" \ "/bin/cp -v '%2' '%3';\n", GetWorkflowDirectory(), String.Quote(file_from), String.Quote(file_to) ) ) ) # successfully copied if Ops.get_integer(cmd, "exit", -1) == 0 file_location = file_to else Builtins.y2error("Error occurred while copying control file: %1", cmd) # Not in installation, try to skip the error if !Stage.initial && FileUtils.Exists(file_from) Builtins.y2milestone("Using fallback file %1", file_from) file_location = file_from end end file_location end |
- (Boolean) UpdateInstallation(update_file, name, domain)
Adapts the current workflow according to specified XML file content
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 |
# File '../../src/modules/WorkflowManager.rb', line 947 def UpdateInstallation(update_file, name, domain) update_file = deep_copy(update_file) PrepareSystemProposals() PrepareSystemWorkflows() proposals = Ops.get_list(update_file, "proposals", []) proposals = PrepareProposals(proposals) UpdateProposals(proposals, name, domain) workflows = Ops.get_list(update_file, "workflows", []) workflows = PrepareWorkflows(workflows) UpdateWorkflows(workflows, name, domain) true end |
- (Boolean) UpdateInstFinish(additional_steps)
Add specified steps to inst_finish. Just modifies internal variables, inst_finish grabs them itself
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 |
# File '../../src/modules/WorkflowManager.rb', line 913 def UpdateInstFinish(additional_steps) additional_steps = deep_copy(additional_steps) before_chroot = Ops.get(additional_steps, "before_chroot", []) after_chroot = Ops.get(additional_steps, "after_chroot", []) before_umount = Ops.get(additional_steps, "before_umount", []) @additional_finish_steps_before_chroot = Convert.convert( Builtins.merge(@additional_finish_steps_before_chroot, before_chroot), from: "list", to: "list <string>" ) @additional_finish_steps_after_chroot = Convert.convert( Builtins.merge(@additional_finish_steps_after_chroot, after_chroot), from: "list", to: "list <string>" ) @additional_finish_steps_before_umount = Convert.convert( Builtins.merge(@additional_finish_steps_before_umount, before_umount), from: "list", to: "list <string>" ) true end |
- (Boolean) UpdateProductInfo(update_file, _filename)
Update product options such as global settings, software, partitioning or network.
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 |
# File '../../src/modules/WorkflowManager.rb', line 1132 def UpdateProductInfo(update_file, _filename) update_file = deep_copy(update_file) # merging all 'map <string, any>' type Builtins.foreach(["globals", "software", "partitioning", "network"]) do |section| sect = ProductFeatures.GetSection(section) addon = Ops.get_map(update_file, section, {}) sect = Convert.convert( Builtins.union(sect, addon), from: "map", to: "map <string, any>" ) ProductFeatures.SetSection(section, sect) end # merging 'clone_modules' addon_clone = Ops.get_list(update_file, "clone_modules", []) ProductControl.clone_modules = Convert.convert( Builtins.merge(ProductControl.clone_modules, addon_clone), from: "list", to: "list <string>" ) # merging texts # # **Structure:** # # $[ # "congratulate" : $[ # "label" : "some text", # ], # "congratulate2" : $[ # "label" : "some other text", # "textdomain" : "control-2", // (optionally) # ], # ]; controlfile_texts = ProductFeatures.GetSection("texts") update_file_texts = Ops.get_map(update_file, "texts", {}) update_file_textdomain = Ops.get_string(update_file, "textdomain", "") # if textdomain is different to the base one # we have to put it into the map if !update_file_textdomain.nil? && update_file_textdomain != "" update_file_texts = Builtins.mapmap(update_file_texts) do |text_ident, text_def| Ops.set(text_def, "textdomain", update_file_textdomain) { text_ident => text_def } end end controlfile_texts = Convert.convert( Builtins.union(controlfile_texts, update_file_texts), from: "map", to: "map <string, any>" ) ProductFeatures.SetSection("texts", controlfile_texts) true end |
- (Boolean) UpdateProposals(proposals, prod_name, domain)
Update system proposals according to proposal update metadata
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
# File '../../src/modules/WorkflowManager.rb', line 700 def UpdateProposals(proposals, prod_name, domain) proposals = deep_copy(proposals) Builtins.foreach(proposals) do |proposal| name = Ops.get_string(proposal, "name", "") stage = Ops.get_string(proposal, "stage", "") mode = Ops.get_string(proposal, "mode", "") arch = Ops.get_string(proposal, "archs", "") found = false new_proposals = [] arch_all_prop = {} Builtins.foreach(ProductControl.proposals) do |p| if Ops.get_string(p, "stage", "") != stage || Ops.get_string(p, "mode", "") != mode || Ops.get_string(p, "name", "") != name new_proposals = Builtins.add(new_proposals, p) next end if Ops.get_string(p, "archs", "") == arch || arch == "" || arch == "all" p = MergeProposal(p, proposal, prod_name, domain) found = true elsif Ops.get_string(p, "archs", "") == "" || Ops.get_string(p, "archs", "") == "all" arch_all_prop = deep_copy(p) end new_proposals = Builtins.add(new_proposals, p) end if !found if arch_all_prop != {} Ops.set(arch_all_prop, "archs", arch) proposal = MergeProposal(arch_all_prop, proposal, prod_name, domain) # completly new proposal else Ops.set(proposal, "textdomain", domain) end new_proposals = Builtins.add(new_proposals, proposal) end ProductControl.proposals = deep_copy(new_proposals) end true end |
- (Boolean) UpdateWorkflows(workflows, prod_name, domain)
Update system workflows according to workflow update metadata
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 |
# File '../../src/modules/WorkflowManager.rb', line 857 def UpdateWorkflows(workflows, prod_name, domain) workflows = deep_copy(workflows) Builtins.foreach(workflows) do |workflow| stage = Ops.get_string(workflow, "stage", "") mode = Ops.get_string(workflow, "mode", "") arch = Ops.get_string(workflow, "archs", "") found = false new_workflows = [] arch_all_wf = {} Builtins.foreach(ProductControl.workflows) do |w| if Ops.get_string(w, "stage", "") != stage || Ops.get_string(w, "mode", "") != mode new_workflows = Builtins.add(new_workflows, w) next end if Ops.get_string(w, ["defaults", "archs"], "") == arch || arch == "" || arch == "all" w = MergeWorkflow(w, workflow, prod_name, domain) found = true elsif Ops.get_string(w, ["defaults", "archs"], "") == "" || Ops.get_string(w, ["default", "archs"], "") == "all" arch_all_wf = deep_copy(w) end new_workflows = Builtins.add(new_workflows, w) end if !found if arch_all_wf != {} Ops.set(arch_all_wf, ["defaults", "archs"], arch) workflow = MergeWorkflow(arch_all_wf, workflow, prod_name, domain) # completly new workflow else Ops.set(workflow, "textdomain", domain) Ops.set( workflow, "modules", Builtins.maplist(Ops.get_list(workflow, "modules", [])) do |mod| Ops.set(mod, "textdomain", domain) deep_copy(mod) end ) end new_workflows = Builtins.add(new_workflows, workflow) end ProductControl.workflows = deep_copy(new_workflows) end true end |
- (Boolean) WorkflowRequiresRegistration(src_id)
Returns whether a repository workflow requires registration
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 |
# File '../../src/modules/WorkflowManager.rb', line 1077 def WorkflowRequiresRegistration(src_id) ret = false Builtins.y2milestone("Known workflows: %1", @workflows_to_sources) Builtins.y2milestone( "Workflows requiring registration: %1", @workflows_requiring_registration ) Builtins.foreach(@workflows_to_sources) do |one_workflow, id| # sources match and workflow is listed as 'requiring registration' if src_id == id && Builtins.contains(@workflows_requiring_registration, one_workflow) ret = true raise Break end end Builtins.y2milestone("WorkflowRequiresRegistration(%1): %2", src_id, ret) ret end |
- (Object) WorkflowsRequiringRegistration
Returns list of workflows requiring registration
1069 1070 1071 |
# File '../../src/modules/WorkflowManager.rb', line 1069 def WorkflowsRequiringRegistration deep_copy(@workflows_requiring_registration) end |