Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update DrupalIntegration.md file 

Signed-off-by: Vitalii Koshura <lestat.de.lionkur@gmail.com>
Vitalii Koshura 2023-04-09 17:14:48 +02:00
parent 682a6d95c7
commit f84a7785e1
No known key found for this signature in database
GPG Key ID: CE0DB1726070A5A3
4 changed files with 29 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
BOINC-Drupal_dataflow.png Normal file

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 155 KiB

BIN
BOINC-Drupal_module_organization.png Normal file

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 118 KiB

BIN
BOINC-Drupal_web_root.png Normal file

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 49 KiB

54
DrupalIntegration.md

@ -1,8 +1,7 @@
[[TOC]] # Overview
BOINC-Drupal integration harnesses many powerful functions of the Drupal development framework and content management system, both simplifying the management of BOINC projects and improving the end user experience on project websites. BOINC-Drupal integration harnesses many powerful functions of the Drupal development framework and content management system, both simplifying the management of BOINC projects and improving the end user experience on project websites.
# Benefits of Drupal ## Benefits of Drupal
The philosophy of Drupal is to keep things simple and modular. Theme code for visual design is separate from site functionality logic, which is separate from the site content itself (it is similar to MVC, but is more appropriately a PAC architecture). Distinct types of functionality are packaged together in modules for simple organization. These modules can be turned on and off, leveraged by other modules, or even shared for use in other development projects. The philosophy of Drupal is to keep things simple and modular. Theme code for visual design is separate from site functionality logic, which is separate from the site content itself (it is similar to MVC, but is more appropriately a PAC architecture). Distinct types of functionality are packaged together in modules for simple organization. These modules can be turned on and off, leveraged by other modules, or even shared for use in other development projects.
Drupal offers a number of benefits to project maintainers: Drupal offers a number of benefits to project maintainers:
@ -18,59 +17,62 @@ Simplified management for project maintainers allows more time to be spent on co
Current BOINC projects that make use of Drupal integration: Current BOINC projects that make use of Drupal integration:
* [Albert@home](https://albertathome.org) (test project for Einstein@home) * [Einstein@Home](https://einsteinathome.org)
# Drupal Module Organization ## Drupal Module Organization
Drupal is built on the concept of a solid core set of functions that can be extended as required to handle the specific needs of a project. The "Drupal way" of doing almost anything is to take a core function or theme and augment it by hooking into it with a module, which essentially just adds the desired code to an existing routine. The code for core Drupal functions should never be modified directly! Custom modules can be written to provide new functions, or there is a large community of developers building and maintaining shared modules on the drupal.org website. Most of the functionality needed for integration with BOINC is provided by these third party modules. Drupal is built on the concept of a solid core set of functions that can be extended as required to handle the specific needs of a project. The "Drupal way" of doing almost anything is to take a core function or theme and augment it by hooking into it with a module, which essentially just adds the desired code to an existing routine. The code for core Drupal functions should never be modified directly! Custom modules can be written to provide new functions, or there is a large community of developers building and maintaining shared modules on the drupal.org website. Most of the functionality needed for integration with BOINC is provided by these third party modules.
The structure of any Drupal site revolves around the core functions of Drupal, third party enhancements to that core, and custom code that provides any required functionality not otherwise available by either of those established channels. This organization could be described as some combination of core, contrib, and custom modules working together to provide high level site features: The structure of any Drupal site revolves around the core functions of Drupal, third party enhancements to that core, and custom code that provides any required functionality not otherwise available by either of those established channels. This organization could be described as some combination of core, contrib, and custom modules working together to provide high level site features:
[[800px)](Image(BOINC-Drupal_module_organization.png,)] ![800px](BOINC-Drupal_module_organization.png)
Modules generally build on other modules, so a custom module to enhance part of the system may work in conjunction with half a dozen other modules in order to provide a given function. Modules generally build on other modules, so a custom module to enhance part of the system may work in conjunction with half a dozen other modules in order to provide a given function.
## Custom Modules ### Custom Modules
Custom modules can be classified as those providing BOINC features and those that enhance core or contrib (3rd party) Drupal functions. The BOINC modules are the most significant. Custom modules can be classified as those providing BOINC features and those that enhance core or contrib (3rd party) Drupal functions. The BOINC modules are the most significant.
### BOINC Core #### BOINC Core
Provides functions that are potentially used by multiple other modules or are otherwise expected to be needed for any implementation of the system. Provides functions that are potentially used by multiple other modules or are otherwise expected to be needed for any implementation of the system.
### BOINC Import #### BOINC Import
Provides the tools and framework for importing data from a BOINC database into the Drupal database. The data imported by this process is either synchronized so that future changes are applied to both databases or the BOINC data is detached and is no longer updated. Provides the tools and framework for importing data from a BOINC database into the Drupal database. The data imported by this process is either synchronized so that future changes are applied to both databases or the BOINC data is detached and is no longer updated.
### BOINC Stats #### BOINC Stats
Provides graphical charts for user and project activity. Provides graphical charts for user and project activity.
### BOINC Team #### BOINC Team
Provides tools for the management of BOINC teams and adds team details to the user interface. Also allows optional management of team forums. Provides tools for the management of BOINC teams and adds team details to the user interface. Also allows optional management of team forums.
### BOINC User #### BOINC User
Connects Drupal user accounts with BOINC user accounts and provides seamless authentication between them. Also provides user account pages. Connects Drupal user accounts with BOINC user accounts and provides seamless authentication between them. Also provides user account pages.
### BOINC Work #### BOINC Work
Enables data related to work to be accessed from the BOINC database and displayed in user dashboards and elsewhere in the Drupal interface. Also allows management of computing preferences, both for the user and also the project administrator. Enables data related to work to be accessed from the BOINC database and displayed in user dashboards and elsewhere in the Drupal interface. Also allows management of computing preferences, both for the user and also the project administrator.
# Database Integration ## Database Integration
The Drupal system ties into the BOINC database in order to display information for users, hosts, and teams. Most of this involves reading data only, though user profile data and preferences operate in a shared state, allowing changes to be made to the relevant BOINC table records from either the standard BOINC or Drupal enhanced web interfaces. There is also an import module that offers an interface for importing data when it is not feasible to rely on shared or read-only access, as is the case for discussion forums and private messages. The following diagram details how the BOINC database is used by the Drupal system: The Drupal system ties into the BOINC database in order to display information for users, hosts, and teams. Most of this involves reading data only, though user profile data and preferences operate in a shared state, allowing changes to be made to the relevant BOINC table records from either the standard BOINC or Drupal enhanced web interfaces. There is also an import module that offers an interface for importing data when it is not feasible to rely on shared or read-only access, as is the case for discussion forums and private messages. The following diagram details how the BOINC database is used by the Drupal system:
[[800px)](Image(BOINC-Drupal_dataflow.png,)] ![800px](BOINC-Drupal_dataflow.png)
# Code Organization
## Code Organization
Drupal is installed in a web directory, typically at the root of a virtual host. Initially, this installation is the Drupal core only and contains no contributed modules or custom code. At the top level of the core Drupal installation is a //sites/// directory. This is where contributed and custom modules are deployed. Hosting multiple sites from one instance of Drupal is possible by creating directories for each site domain here, each with the modules needed for its corresponding site, and an additional //all/// directory for shared modules and themes. In a single-site deployment, the //default/// directory will be used instead of a domain name. Drupal is installed in a web directory, typically at the root of a virtual host. Initially, this installation is the Drupal core only and contains no contributed modules or custom code. At the top level of the core Drupal installation is a //sites/// directory. This is where contributed and custom modules are deployed. Hosting multiple sites from one instance of Drupal is possible by creating directories for each site domain here, each with the modules needed for its corresponding site, and an additional //all/// directory for shared modules and themes. In a single-site deployment, the //default/// directory will be used instead of a domain name.
[[500px)](Image(BOINC-Drupal_web_root.png,)] ![500px](BOINC-Drupal_web_root.png)
# How to Install
See further documentation at InstallDrupal.
# Basic Site Management with Drupal ## How to Install
See further documentation at [InstallDrupal](InstallDrupal).
## Basic Site Management with Drupal
Admin web interface: Admin web interface:
@ -82,13 +84,13 @@ Using drush on the command line:
* drush fl : List all Features with current status * drush fl : List all Features with current status
* drush fr-all : Reload all Feature configurations from code * drush fr-all : Reload all Feature configurations from code
* drush fu [feature] : Update Feature code using current configuration in Drupal * drush fu [feature](feature) : Update Feature code using current configuration in Drupal
* drush cc : Clear Drupal caches (when in doubt, clear it out... solves many problems) * drush cc : Clear Drupal caches (when in doubt, clear it out... solves many problems)
Typical deployment process: Typical deployment process:
1. Make changes to code and configuration on development system 1. Make changes to code and configuration on development system
1. Check Features list for overrides and run //drush fu// (or use the web interface to recreate any overridden Features) to capture changes 1. Check Features list for overrides and run //drush fu// (or use the web interface to recreate any overridden Features) to capture changes
1. Commit changes to relevant git repository and branch, push to origin 1. Commit changes to relevant git repository and branch, push to origin
1. Pull changes into web root of deployment target (e.g. beta system) 1. Pull changes into web root of deployment target (e.g. beta system)
1. Run //drush fr-all// or opt to revert individual Features to apply changes present in code to the Drupal database 1. Run //drush fr-all// or opt to revert individual Features to apply changes present in code to the Drupal database