From 0f8d11ca8e8312fc0d0dc56e0c2a1154ff3de77c Mon Sep 17 00:00:00 2001 From: Katja Marttila Date: Fri, 9 Mar 2018 10:21:54 +0200 Subject: Enable usage of categorized repositories This change allows to categorize repositories in component selection page. Using categorized repositories will by default show only uncagetorized repository items in tree. Selecting one or several categories using checkbox will update the treeview to show all selected categorized repository content. Repository's metadata is fetched only after the category is selected. Categorized repositories can be defined in config.xml: category 1 (url) ... Reviewed-by: Iikka Eklund --- .../qtifw-examples-repository-categories.png | Bin 0 -> 58532 bytes examples/doc/repositorycategories.qdoc | 117 +++++++++++++++++++++ examples/examples.pro | 1 + examples/repositorycategories/README | 30 ++++++ examples/repositorycategories/config/config.xml | 33 ++++++ .../repositorycategories/packages/A/data/A.txt | 2 + .../packages/A/meta/package.xml | 8 ++ .../repositorycategories/packages/B/data/B.txt | 2 + .../packages/B/meta/package.xml | 8 ++ .../A2Cagetory1/data/A2_category1.txt | 2 + .../A2Cagetory1/meta/package.xml | 8 ++ .../B2Category1/data/B2_category1.txt | 2 + .../B2Category1/meta/package.xml | 8 ++ .../ACagetory1/data/A_category1.txt | 2 + .../ACagetory1/meta/package.xml | 8 ++ .../BCategory1/data/B_category1.txt | 2 + .../BCategory1/meta/package.xml | 8 ++ .../ACategory2/data/A_category2.txt | 2 + .../ACategory2/meta/package.xml | 8 ++ .../BCategory2/data/B_category2.txt | 2 + .../BCategory2/meta/package.xml | 8 ++ .../repositorycategories/repositorycategories.pro | 13 +++ 22 files changed, 274 insertions(+) create mode 100644 examples/doc/images/qtifw-examples-repository-categories.png create mode 100644 examples/doc/repositorycategories.qdoc create mode 100644 examples/repositorycategories/README create mode 100644 examples/repositorycategories/config/config.xml create mode 100644 examples/repositorycategories/packages/A/data/A.txt create mode 100644 examples/repositorycategories/packages/A/meta/package.xml create mode 100644 examples/repositorycategories/packages/B/data/B.txt create mode 100644 examples/repositorycategories/packages/B/meta/package.xml create mode 100644 examples/repositorycategories/packages2_forcategory1/A2Cagetory1/data/A2_category1.txt create mode 100644 examples/repositorycategories/packages2_forcategory1/A2Cagetory1/meta/package.xml create mode 100644 examples/repositorycategories/packages2_forcategory1/B2Category1/data/B2_category1.txt create mode 100644 examples/repositorycategories/packages2_forcategory1/B2Category1/meta/package.xml create mode 100644 examples/repositorycategories/packages_forcategory1/ACagetory1/data/A_category1.txt create mode 100644 examples/repositorycategories/packages_forcategory1/ACagetory1/meta/package.xml create mode 100644 examples/repositorycategories/packages_forcategory1/BCategory1/data/B_category1.txt create mode 100644 examples/repositorycategories/packages_forcategory1/BCategory1/meta/package.xml create mode 100644 examples/repositorycategories/packages_forcategory2/ACategory2/data/A_category2.txt create mode 100644 examples/repositorycategories/packages_forcategory2/ACategory2/meta/package.xml create mode 100644 examples/repositorycategories/packages_forcategory2/BCategory2/data/B_category2.txt create mode 100644 examples/repositorycategories/packages_forcategory2/BCategory2/meta/package.xml create mode 100644 examples/repositorycategories/repositorycategories.pro (limited to 'examples') diff --git a/examples/doc/images/qtifw-examples-repository-categories.png b/examples/doc/images/qtifw-examples-repository-categories.png new file mode 100644 index 000000000..afed7c1b9 Binary files /dev/null and b/examples/doc/images/qtifw-examples-repository-categories.png differ diff --git a/examples/doc/repositorycategories.qdoc b/examples/doc/repositorycategories.qdoc new file mode 100644 index 000000000..dca5ada43 --- /dev/null +++ b/examples/doc/repositorycategories.qdoc @@ -0,0 +1,117 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the Qt Installer Framework. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example repositorycategories + \ingroup qtifwexamples + \title Repository Categories Example + + \brief Using the RepositoryCategories element to set up an + online installer where repositories are grouped. + + \image qtifw-examples-repository-categories.png + + \e{Repository Categories} illustrates how to set up an installer + where repositories are grouped into categories. + + \include installerfw-examples-configuring.qdocinc + + \list + \li The \c element shows how to group repositories into categories. + \c can contain one or several \c + child elements that specify a connection to repositories. For more + information about \c see + \l{Configuring Repositories}. + \endlist + + \quotefile repositorycategories/config/config.xml + + \include installerfw-examples-packaging.qdocinc + + \list + \li The \c element is set to \c true to preselect the + component in the installer. + \endlist + + \quotefile online/packages/A/meta/package.xml + + \section1 Generating the Online Repository + + This installer contains four packages that each have two components. The \c Packages directory contains two components + that are not grouped categories. They are always visible in tree view in the component selection page. \c Packages_forcategory1 + and \c packages2_forcategory1 both contain two components, which are visible when \c Category 1 is fetched. \c Packages_forcategory2 + contains two components that are visible only when \c Category 2 is fetched. + + The packages need to be converted to a file structure that the installer can + fetch at runtime. To use the \c repogen tool to convert the packages, switch + to the example source directory on the command line and enter the following + command: + + \list + \li On Windows: + \code + ..\..\bin\repogen.exe -p packages repository + ..\..\bin\repogen.exe -p packages_forcategory1 repository1 + ..\..\bin\repogen.exe -p packages2_forcategory1 repository2 + ..\..\bin\repogen.exe -p packages_forcategory2 repository3 + \endcode + \li On Linux or macOS: + \code + ../../bin/repogen -p packages repository + ../../bin/repogen -p packages_forcategory1 repository1 + ../../bin/repogen -p packages2_forcategory1 repository2 + ../../bin/repogen -p packages_forcategory2 repository3 + \endcode + \endlist + + The generated \c repository, \c repository1, \c repository2 and \c repository3 directories will now + contain a full copy of the package data and some additionally generated metadata, such as SHA + checksums. + + The directories now need to be made available at the URL set in + \c config.xml: \c{http://localhost/repository}, \c{http://localhost/repository1}, \c{http://localhost/repository2} and + \c{http://localhost/repository3}. How this is done depends on + the platform and web server used. If you do not have a running web server + yet, but have Python available, you should be able to start a minimal web + server from the command line. Make sure you are in the example directory, + and then enter: + + \code + python -m SimpleHTTPServer 80 + \endcode + + You should now be able to open and explore \l{http://localhost/repository} + in your web browser. + + \note If you do not have enough permissions to set up a web server locally, + you can also specify an absolute \c{file:///} URL as the value of the \c URL + element in \c config.xml. For example, + \c file:///C:/Qt/QtIFW/examples/repositorycategories/repository would be a valid URL on + Windows if \c repository is located in \c C:\Qt\QtIFW\examples\repositorycategories. + + \include installerfw-examples-generating-online.qdocinc +*/ diff --git a/examples/examples.pro b/examples/examples.pro index 377632b9c..bfe69a5c8 100644 --- a/examples/examples.pro +++ b/examples/examples.pro @@ -11,6 +11,7 @@ SUBDIRS += \ openreadme \ quitinstaller \ registerfileextension \ + repositorycategories \ startmenu \ systeminfo \ stylesheet diff --git a/examples/repositorycategories/README b/examples/repositorycategories/README new file mode 100644 index 000000000..4a1f491c6 --- /dev/null +++ b/examples/repositorycategories/README @@ -0,0 +1,30 @@ +Shows how to set up an online installer and how to use categorized repositories. Categorized repositories are not loaded to the tree view by default, instead you can select +to show categorized repositories in a tree view combobox. By default, repositories without categories are always shown in the tree view. + +The example uses a very simple web server shipped with Python. + +Generate the online repositories with + + repogen -p packages repository + repogen -p packages_forcategory1 repository1 + repogen -p packages2_forcategory1 repository2 + repogen -p packages_forcategory2 repository3 + +Generate the installer with + + binarycreator --online-only -c config/config.xml -p packages installer + +Now launch a minimal web server in the example's directory (admin rights may be needed) + + python -m SimpleHTTPServer 80 + +This should make the content of the local directory available under +http://localhost + +You should be able to now launch the installer. + +To deploy an update, run + + repogen --update-new-components -p packages_update repository + +and launch the maintenance tool in your installation. diff --git a/examples/repositorycategories/config/config.xml b/examples/repositorycategories/config/config.xml new file mode 100644 index 000000000..c61e4893d --- /dev/null +++ b/examples/repositorycategories/config/config.xml @@ -0,0 +1,33 @@ + + + Repository category Installer Example + 1.0.0 + Repository category Installer Example + The Qt Company + + Qt IFW Examples + @HomeDir@/IfwExamples/repositoryCategories + + + http://localhost/repository + + + + Releases + + Category 1 + + http://localhost/repository1 + + + http://localhost/repository2 + + + + Category 2 + + http://localhost/repository3 + + + + diff --git a/examples/repositorycategories/packages/A/data/A.txt b/examples/repositorycategories/packages/A/data/A.txt new file mode 100644 index 000000000..98114dd6e --- /dev/null +++ b/examples/repositorycategories/packages/A/data/A.txt @@ -0,0 +1,2 @@ +Example content for package A. + diff --git a/examples/repositorycategories/packages/A/meta/package.xml b/examples/repositorycategories/packages/A/meta/package.xml new file mode 100644 index 000000000..08cef59c0 --- /dev/null +++ b/examples/repositorycategories/packages/A/meta/package.xml @@ -0,0 +1,8 @@ + + + A + Example component A + 1.0.2-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages/B/data/B.txt b/examples/repositorycategories/packages/B/data/B.txt new file mode 100644 index 000000000..1ee864074 --- /dev/null +++ b/examples/repositorycategories/packages/B/data/B.txt @@ -0,0 +1,2 @@ +Example content for package B. + diff --git a/examples/repositorycategories/packages/B/meta/package.xml b/examples/repositorycategories/packages/B/meta/package.xml new file mode 100644 index 000000000..44e90b9a2 --- /dev/null +++ b/examples/repositorycategories/packages/B/meta/package.xml @@ -0,0 +1,8 @@ + + + B + Example component B + 1.0.0-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages2_forcategory1/A2Cagetory1/data/A2_category1.txt b/examples/repositorycategories/packages2_forcategory1/A2Cagetory1/data/A2_category1.txt new file mode 100644 index 000000000..2b328a750 --- /dev/null +++ b/examples/repositorycategories/packages2_forcategory1/A2Cagetory1/data/A2_category1.txt @@ -0,0 +1,2 @@ +Example content for package A2, using category 1. + diff --git a/examples/repositorycategories/packages2_forcategory1/A2Cagetory1/meta/package.xml b/examples/repositorycategories/packages2_forcategory1/A2Cagetory1/meta/package.xml new file mode 100644 index 000000000..02d175868 --- /dev/null +++ b/examples/repositorycategories/packages2_forcategory1/A2Cagetory1/meta/package.xml @@ -0,0 +1,8 @@ + + + A2 (from category 1) + Example component A2 + 1.0.3-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages2_forcategory1/B2Category1/data/B2_category1.txt b/examples/repositorycategories/packages2_forcategory1/B2Category1/data/B2_category1.txt new file mode 100644 index 000000000..56baa1709 --- /dev/null +++ b/examples/repositorycategories/packages2_forcategory1/B2Category1/data/B2_category1.txt @@ -0,0 +1,2 @@ +Example content for package B2, using category 1. + diff --git a/examples/repositorycategories/packages2_forcategory1/B2Category1/meta/package.xml b/examples/repositorycategories/packages2_forcategory1/B2Category1/meta/package.xml new file mode 100644 index 000000000..0c0b0411d --- /dev/null +++ b/examples/repositorycategories/packages2_forcategory1/B2Category1/meta/package.xml @@ -0,0 +1,8 @@ + + + B2 (from category 1) + Example component B + 1.0.0-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages_forcategory1/ACagetory1/data/A_category1.txt b/examples/repositorycategories/packages_forcategory1/ACagetory1/data/A_category1.txt new file mode 100644 index 000000000..e899cb202 --- /dev/null +++ b/examples/repositorycategories/packages_forcategory1/ACagetory1/data/A_category1.txt @@ -0,0 +1,2 @@ +Example content for package A, using category 1. + diff --git a/examples/repositorycategories/packages_forcategory1/ACagetory1/meta/package.xml b/examples/repositorycategories/packages_forcategory1/ACagetory1/meta/package.xml new file mode 100644 index 000000000..1f0e795e9 --- /dev/null +++ b/examples/repositorycategories/packages_forcategory1/ACagetory1/meta/package.xml @@ -0,0 +1,8 @@ + + + A (from category 1) + Example component A + 1.0.3-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages_forcategory1/BCategory1/data/B_category1.txt b/examples/repositorycategories/packages_forcategory1/BCategory1/data/B_category1.txt new file mode 100644 index 000000000..d355cb633 --- /dev/null +++ b/examples/repositorycategories/packages_forcategory1/BCategory1/data/B_category1.txt @@ -0,0 +1,2 @@ +Example content for package B, using category 1. + diff --git a/examples/repositorycategories/packages_forcategory1/BCategory1/meta/package.xml b/examples/repositorycategories/packages_forcategory1/BCategory1/meta/package.xml new file mode 100644 index 000000000..98b9776fd --- /dev/null +++ b/examples/repositorycategories/packages_forcategory1/BCategory1/meta/package.xml @@ -0,0 +1,8 @@ + + + B (from category 1) + Example component B + 1.0.0-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages_forcategory2/ACategory2/data/A_category2.txt b/examples/repositorycategories/packages_forcategory2/ACategory2/data/A_category2.txt new file mode 100644 index 000000000..0a10aa452 --- /dev/null +++ b/examples/repositorycategories/packages_forcategory2/ACategory2/data/A_category2.txt @@ -0,0 +1,2 @@ +Example content for package A, using category 2. + diff --git a/examples/repositorycategories/packages_forcategory2/ACategory2/meta/package.xml b/examples/repositorycategories/packages_forcategory2/ACategory2/meta/package.xml new file mode 100644 index 000000000..25a25f94e --- /dev/null +++ b/examples/repositorycategories/packages_forcategory2/ACategory2/meta/package.xml @@ -0,0 +1,8 @@ + + + A (from category 2) + Example component A + 1.0.3-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/packages_forcategory2/BCategory2/data/B_category2.txt b/examples/repositorycategories/packages_forcategory2/BCategory2/data/B_category2.txt new file mode 100644 index 000000000..ebf02b452 --- /dev/null +++ b/examples/repositorycategories/packages_forcategory2/BCategory2/data/B_category2.txt @@ -0,0 +1,2 @@ +Example content for package B, using category 2. + diff --git a/examples/repositorycategories/packages_forcategory2/BCategory2/meta/package.xml b/examples/repositorycategories/packages_forcategory2/BCategory2/meta/package.xml new file mode 100644 index 000000000..fa21c631b --- /dev/null +++ b/examples/repositorycategories/packages_forcategory2/BCategory2/meta/package.xml @@ -0,0 +1,8 @@ + + + B (from category 2) + Example component B + 1.0.0-1 + 2015-01-01 + true + diff --git a/examples/repositorycategories/repositorycategories.pro b/examples/repositorycategories/repositorycategories.pro new file mode 100644 index 000000000..37a0144b7 --- /dev/null +++ b/examples/repositorycategories/repositorycategories.pro @@ -0,0 +1,13 @@ +TEMPLATE = aux + +INSTALLER = installer + +INPUT = $$PWD/config/config.xml $$PWD/packages +example.input = INPUT +example.output = $$INSTALLER +example.commands = ../../bin/binarycreator --online-only -c $$PWD/config/config.xml -p $$PWD/packages ${QMAKE_FILE_OUT} +example.CONFIG += target_predeps no_link combine + +QMAKE_EXTRA_COMPILERS += example + +OTHER_FILES = README -- cgit v1.2.3