Source code for cobbler.cobbler_collections.menus

"""
Copyright 2021 Yuriy Chelpanov
Yuriy Chelpanov <yuriy.chelpanov@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301  USA
"""

from cobbler.items import menu
from cobbler.cobbler_collections import collection
from cobbler import utils
from cobbler.cexceptions import CX




class Menus(collection.Collection):
    """
    A menu represents an element of the hierarchical boot menu.
    """



    @staticmethod
    def collection_type() -> str:
        return "menu"




    @staticmethod
    def collection_types() -> str:
        return "menus"




    def factory_produce(self, api, item_dict):
        """
        Return a Menu forged from item_dict

        :param api: The cobblerd API.
        :param item_dict: The seed data.
        :return: A new menu instance.
        """
        return menu.Menu(api, **item_dict)




    def remove(self, name: str, with_delete: bool = True, with_sync: bool = True, with_triggers: bool = True,
               recursive: bool = False):
        """
        Remove element named 'name' from the collection

        :param name: The name of the menu
        :param with_delete: In case the deletion triggers are executed for this menu.
        :param with_sync: In case a Cobbler Sync should be executed after the action.
        :param with_triggers: In case the Cobbler Trigger mechanism should be executed.
        :param recursive: In case you want to delete all objects this menu references.
        :raises CX: Raised in case you want to delete a none existing menu.
        """
        obj = self.find(name=name)
        if obj is None or not isinstance(obj, menu.Menu):
            raise CX(f"cannot delete an object that does not exist: {name}")

        for item_type in ["image", "profile"]:
            items = self.api.find_items(item_type, {"menu": obj.name}, return_list=True)
            if items is None:
                continue
            if not isinstance(items, list):
                raise ValueError("Expected list or None from find_items!")
            for item in items:
                item.menu = ""

        if recursive:
            kids = obj.descendants
            kids.sort(key=lambda x: -x.depth)
            for kid in kids:
                self.api.remove_item(
                    kid.COLLECTION_TYPE,
                    kid,
                    recursive=False,
                    delete=with_delete,
                    with_triggers=with_triggers,
                    with_sync=with_sync,
                )

        if with_delete:
            if with_triggers:
                utils.run_triggers(self.api, obj, "/var/lib/cobbler/triggers/delete/menu/pre/*", [])
        self.lock.acquire()
        try:
            self.remove_from_indexes(obj)
            del self.listing[name]
        finally:
            self.lock.release()
        self.collection_mgr.serialize_delete(self, obj)
        if with_delete:
            if with_triggers:
                utils.run_triggers(self.api, obj, "/var/lib/cobbler/triggers/delete/menu/post/*", [])
                utils.run_triggers(self.api, obj, "/var/lib/cobbler/triggers/change/*", [])
            if with_sync:
                lite_sync = self.api.get_sync()
                lite_sync.remove_single_menu()