recycled-ni-neutrino/src/gui/opkg_manager.h

/*
	Based up Neutrino-GUI - Tuxbox-Project
	Copyright (C) 2001 by Steffen Hehn 'McClean'

	OPKG-Manager Class for Neutrino-GUI

	Implementation:
	Copyright (C) 2012-2023 T. Graf 'dbt'

	Adaptions:
	Copyright (C) 2013 martii
	gitorious.org/neutrino-mp/martiis-neutrino-mp

	License: GPL

	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, see <http://www.gnu.org/licenses/>.
*/

#ifndef __OPKG_MANAGER__
#define __OPKG_MANAGER__

#include "widget/hintbox.h"
#include "widget/menue.h"

#include <map>
#include <mutex>
#include <string>
#include <vector>

#define OPKG_MAX_FEEDS 10
#define HAS_PKG_UPDATE_FLAGFILE  "/tmp/.has_pkg_updates"

class COPKGManagerExtra
{
	public:
		// set update status to passed menu item
		void setUpdateStateIcon2Item(CMenuItem* item);
};

class COPKGManager : public CMenuTarget, public COPKGManagerExtra
{
	friend class CImageInfo;

	private:
		struct pkg {
			std::string 	name,
					version,
					desc,
					section,
					priority,
					recommends,
					status,
					architecture,
					maintainer,
					md5sum,
					size,
					filename,
					source,
					homepage,
					license,
					installed_size,
					installed_time,
					hint;
			bool installed;
			bool upgradable;
			CMenuForwarder *forwarder;
				pkg() { }
				pkg(std::string &_name)
					: name(_name),
					version(""),
					desc(""),
					section(""),
					priority(""),
					recommends(""),
					status(""),
					architecture(""),
					maintainer(""),
					md5sum(""),
					size(""),
					filename(""),
					source(""),
					homepage(""),
					license(""),
					installed_size(""),
					installed_time(""),
					hint(""),
					installed(false),
					upgradable(false),
					forwarder(NULL) { }
		};
		std::map<std::string,pkg> pkg_map;

		int width;
		int is_wizard;
		std::string terminal_str;
		void init(int wizard_mode);
		bool silent; // Controls some screen messages, eg, avoids unintended or disturbing messages on update checks at background.

		//filter
		std::vector<std::string> v_bad_pattern, v_good_pattern;

		CMenuWidget *menu;
		bool menu_used;
		bool installed;
		bool expert_mode;
		std::string *local_dir;

		CLoaderHint *loadBox;

		bool has_err;
		typedef struct OPKG_error_data_t
		{
			std::string	id;
			int		num;
		}OPKG_error_struct_t;
		//error types
		enum
		{
			OPKG_UNKNOWN_ERR 		=-1,
			OPKG_SUCCESS		= 0,
			OPKG_UNSATISFIED_DEPS_ERR = 5,
			OPKG_DOWNLOAD_ERR		= 11,
			OPKG_CONFLICT_ERR		= 12,
			OPKG_OUT_OF_SPACE_ERR	= 15,
			OPKG_PREREM_SCRIPT_ERR	= 16,
		};
		OPKG_error_data_t *err_list;
		void OPKG_ERRORS()
		{
			static OPKG_error_data_t errlist[] = { 	{ "Cannot satisfy the following dependencies"	, OPKG_UNSATISFIED_DEPS_ERR	}, 
								{ "No space left on device"			, OPKG_OUT_OF_SPACE_ERR 		},
								{ "The following packages conflict"		, OPKG_CONFLICT_ERR		},
								{ "Only have"					, OPKG_OUT_OF_SPACE_ERR 		},
								{ "prerm script for package"			, OPKG_PREREM_SCRIPT_ERR		},
							} ;
			err_list = errlist;
		};
		void showErr(int* res);

		int execCmd(const char* cmdstr, int verbose_mode = 0);
		int execCmd(std::string cmdstr, int verbose_mode = 0) {
			return execCmd(cmdstr.c_str(), verbose_mode);
		};
		void pullPkgData();
		std::string getBlankPkgName(const std::string &line);

		void handleUpdateFlagFile();
		void initUpdateMessage(bool enable_message = true);
		bool removeInfoBarTxt();
		std::mutex opk_mutex;

		/*!
		* Gets an info from from a package via keywords as std::string
		* 1st parameter is name of package as string eg. "gdb", without file extension or version data
		* 2nd parameter needs a keyword like:
		* Version, Depends, Status, Section, Architecture, Maintainer, MD5Sum, Size, Filename, Source, Description
		* These kewords are to find in the control package inside of the opkg package file and the package list.
		*/
		std::string getPkgInfo(const std::string &pkg_name, const std::string &pkg_key = "");

		int initMenu();
		void updateMenu();

		typedef enum
		{
			OPKG_BAD_LIST 	= 0,
			OPKG_GOOD_LIST 	= 1
		}opkg_pattern_list_t;

		void initPackagePatternLists();
		static std::vector<std::string> getPackagePatternList(opkg_pattern_list_t type);

		//!Returns a vector with possible filter entries from OPKG_BAD_PATTERN_LIST_FILE or OPKG_GOOD_PATTERN_LIST_FILE
		static std::vector<std::string> getBadPackagePatternList();
		static std::vector<std::string> getGoodPackagePatternList();

		bool isFilteredPackage(std::string &package_name, opkg_pattern_list_t type);
		/*!
		* Returns true if found a ''bad'' package, Parameter: package name as std::string by rev
		* To detect bad packages, it must be exist a matching pattern list file.
		* Path is defined in OPKG_X_PATTERN_LIST_FILE.
		* This provides the option to filter some unwanted entries in the package list menue.
		* This makes sense eg. to hinder that the user could change important system packages.
		* NOTE: a sample file you should find here as : "/var/tuxbox/config/bad_package_pattern.list.sample"
		* If required, remove the ".sample" extension and change the entries for your requirements
		* howto: a simple way to filter a package is to add the pure name, if you want
		* to hide a package (even which name) then add this name to a line. Eg. if you want to hide
		* package wget then add this and this package is not displayed at the gui.
		* Also a few place holders should work, see the isBadPackage() function, but this
		* can be inaccurately because it could filter innocent packages.
		*/
		bool isBadPackage(std::string &package_name);
		/*!
		The same like isBadPackage() but as whitlist
		*/
		bool isGoodPackage(std::string &package_name);
		bool isPermittedPackage(std::string &package_name);

		void showError(const char* local_msg, char* err_msg = NULL, const std::string &additional_text = std::string());
		int doUpdate();
		void handleShellOutput(std::string* cur_line, int* res, bool* ok);

		int num_updates;
	public:
		COPKGManager(int wizard_mode = SNeutrinoSettings::WIZARD_OFF);
		~COPKGManager();

		void setWizardMode(int mode) {is_wizard = mode;}
		int exec(CMenuTarget* parent, const std::string &actionKey);
		static bool hasOpkgSupport();
		bool checkUpdates(bool show_progress = false);
		int getNumUpdates();
		void setUpdateCheckResult(bool enable_message = true);
		bool installPackage(const std::string &pkg_name, std::string options = std::string(), bool force_configure = false);
};

#endif