Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New commands proposal #488

Merged
merged 2 commits into from
Jul 2, 2024
Merged

New commands proposal #488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1ab51a
add new developped moosh commands that maybe usefull to others
cperves Jun 28, 2024
0749ea2
correction hemp
cperves Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
289 changes: 289 additions & 0 deletions Moosh/Command/Generic/Plugin/PluginHideShow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
<?php
/**
* moosh - Moodle Shell
*
* @auhtor 2021 Céline Pervès <[email protected]>
* @copyright Université de Strasbourg unistra.fr
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace Moosh\Command\Generic\Plugin;
use Moosh\MooshCommand;

class PluginHideShow extends MooshCommand
{

public function __construct()
{
parent::__construct('hideshow', 'plugin');
$this->addArgument('plugintype');
$this->addArgument('pluginname');
$this->addArgument('show');
}

public function execute()
{
global $CFG,$DB;

if(!is_numeric($this->arguments[2])){
echo "hideshow must be an integer\n";
die;
}
$show=(int)$this->arguments[2];
$plugintype = $this->arguments[0];
$pluginname = $this->arguments[1];
switch($plugintype){
case 'block':
self::hideshow_values_check($pluginname,array(0,1));
if (!$block = $DB->get_record('block', array('name'=>$pluginname))) {
echo "$plugintype $pluginname not exists";
break;
}
$DB->set_field('block', 'visible', $show, array('id'=>$block->id));
add_to_config_log('block_visibility', $block->visible, ''.$show, $block->name);
\core_plugin_manager::reset_caches();
break;
case 'mod':
self::hideshow_values_check($show,array(0,1));
if (!$module = $DB->get_record("modules", array("name"=>$pluginname))) {
echo "$plugintype $pluginname not exists";
break;
}
$DB->set_field("modules", "visible", $show, array("id"=>$module->id)); // Hide main module
if($show==0){
// Remember the visibility status in visibleold.
// And hide...
$sql = "UPDATE {course_modules}
SET visibleold=visible, visible=0
WHERE module=?";
$DB->execute($sql, array($module->id));
// Increment course.cacherev for courses where we just made something invisible.
// This will force cache rebuilding on the next request.
increment_revision_number('course', 'cacherev',
"id IN (SELECT DISTINCT course
FROM {course_modules}
WHERE visibleold=1 AND module=?)",
array($module->id));
\core_plugin_manager::reset_caches();
}else{
$DB->set_field('course_modules', 'visible', '1', array('visibleold'=>1, 'module'=>$module->id)); // Get the previous saved visible state for the course module.
// Increment course.cacherev for courses where we just made something visible.
// This will force cache rebuilding on the next request.
increment_revision_number('course', 'cacherev',
"id IN (SELECT DISTINCT course
FROM {course_modules}
WHERE visible=1 AND module=?)",
array($module->id));
\core_plugin_manager::reset_caches();
}
break;
case 'assignfeedback':
case 'assignsubmission':
self::hideshow_values_check($show,array(0,1));
//check pluginname
if(count((array)get_config($plugintype.'_'.$pluginname))==0){
cli_error(get_string('hideshow_plugin_cli_pluginnotexists','tool_cmdlinetools',array('name'=>$pluginname, 'type'=> $plugintype)));
}
set_config('disabled', $show==0?1:0, $plugintype . '_' . $pluginname);
break;
case 'qtype':
require_once($CFG->dirroot.'/question/engine/bank.php');
self::hideshow_values_check($show,array(0,1));
//check qtype
if(!array_key_exists ($pluginname, \question_bank::get_all_qtypes())){
echo "qtype $pluginname does not exist";
}
if($show==0){
set_config($pluginname . '_disabled',1, 'question');
}else{
$qtype = \question_bank::get_qtype($pluginname,true);
if (!$qtype->menu_name()) {
echo "cannot enable qtype $pluginname";
break;
}
unset_config($pluginname . '_disabled', 'question');
}
break;
case 'qbehaviour':
self::hideshow_values_check($show,array(0,1));
require_once($CFG->dirroot.'/question/engine/lib.php');
//check qbehaviour
if(!array_key_exists ($pluginname, core_component::get_plugin_list('qbehaviour'))){
echo "qbehaviour $pluginname does not exist";
break;
}
if(!question_engine::is_behaviour_archetypal($pluginname)){
echo "can't enable/disable qbehaviour $pluginname";
break;
}
$config = get_config('question');
if (!empty($config->disabledbehaviours)) {
$disabledbehaviours = explode(',', $config->disabledbehaviours);
} else {
$disabledbehaviours = array();
}
$disabledbehaviours_index = array_search($pluginname,$disabledbehaviours);
if($disabledbehaviours_index!==false && $show==1){
unset($disabledbehaviours[$disabledbehaviours_index]);
set_config('disabledbehaviours', implode(',', $disabledbehaviours), 'question');
}else if ($disabledbehaviours_index === false && $show ==0){
$disabledbehaviours[] = $pluginname;
set_config('disabledbehaviours', implode(',', $disabledbehaviours), 'question');
}
\core_plugin_manager::reset_caches();
break;
case 'enrol':
self::hideshow_values_check($show,array(0,1));
$syscontext = \context_system::instance();
$enabled = enrol_get_plugins(true);
$all = enrol_get_plugins(false);
if(!array_key_exists($pluginname,$all)){
echo "enrol method $pluginname not exists";
break;
}
if($show==0 && array_key_exists($pluginname,$enabled)){
unset($enabled[$pluginname]);
set_config('enrol_plugins_enabled', implode(',', array_keys($enabled)));
\core_plugin_manager::reset_caches();
$syscontext->mark_dirty(); // resets all enrol caches
}else if($show == 1 && !array_key_exists($pluginname, $enabled)){
$enabled = array_keys($enabled);
$enabled[] = $pluginname;
set_config('enrol_plugins_enabled', implode(',', $enabled));
\core_plugin_manager::reset_caches();
$syscontext->mark_dirty(); // resets all enrol caches
}
break;
case 'filter':
require_once($CFG->libdir.'/filterlib.php');
self::hideshow_values_check($show,array(1,-1,-9999));
//check if filter exists
if(!array_key_exists($pluginname,filter_get_all_installed())){
echo "filter $pluginname does not exist";
break;
}
filter_set_global_state('filter/'.$pluginname, $show);
if ($show == TEXTFILTER_DISABLED) {
filter_set_applies_to_strings('filter/'.$pluginname, false);
}
reset_text_filters_cache();
break;
case 'editor':
self::hideshow_values_check($show,array(0,1));
$editors=editors_get_available();
if(!array_key_exists($pluginname,$editors)){
echo "editor $pluginname doesn't exists";
break;
}
$active_editors = explode(',', $CFG->texteditors);
$active_editors_index = array_search($pluginname,$active_editors);
if($show==0 && $active_editors_index !== false){
unset($active_editors[$active_editors_index]);
set_config('texteditors', implode(',', $active_editors));

}else if($show == 1 && $active_editors_index === false){
$active_editors[]=$pluginname;
set_config('texteditors', implode(',', $active_editors));
}
break;
case 'auth':
self::hideshow_values_check($show, array(0,1));
if(!exists_auth_plugin($pluginname)){
echo "auth plugin $pluginname doesn't exists";
break;
}
get_enabled_auth_plugins(true); // fix the list of enabled auths
if (empty($CFG->auth)) {
$authsenabled = array();
} else {
$authsenabled = explode(',', $CFG->auth);
}
if($show==1){
if (!in_array($pluginname, $authsenabled)) {
$authsenabled[] = $pluginname;
$authsenabled = array_unique($authsenabled);
set_config('auth', implode(',', $authsenabled));
}
\core\session\manager::gc(); // Remove stale sessions.
\core_plugin_manager::reset_caches();
}else{
$key = array_search($pluginname, $authsenabled);
if ($key !== false) {
unset($authsenabled[$key]);
set_config('auth', implode(',', $authsenabled));
}

if ($pluginname == $CFG->registerauth) {
set_config('registerauth', '');
}
\core\session\manager::gc(); // Remove stale sessions.
\core_plugin_manager::reset_caches();
}
break;
case 'license':
self::hideshow_values_check($show, array(0,1));
require_once($CFG->libdir.'/licenselib.php');
if(license_manager::get_license_by_shortname($pluginname)==null){
echo "license plugin $pluginname doesn't exists";
break;
}
if($pluginname == $CFG->sitedefaultlicense){
echo "can\'t enable/disable license $pluginname";
break;
}
if($show==1){
license_manager::enable($pluginname);
}else{
license_manager::disable($pluginname);
}
break;
case 'repository':
echo 'not implemented because require repository setting form';
break;
case 'courseformat':
self::hideshow_values_check($show, array(0,1));
require_once($CFG->libdir.'/classes/plugin_manager.php');
$formatplugins = \core_plugin_manager::instance()->get_plugins_of_type('format');
if (!isset($formatplugins[$pluginname])) {
echo "cours eformat $pluginname doesn't exits";
break;
}
if (get_config('moodlecourse', 'format') === $pluginname){
echo "course foramt $pluginname can't be enabled/disabled";
break;
}
if($show == 0){
set_config('disabled', 1, 'format_'. $pluginname);
\core_plugin_manager::reset_caches();
}else{
unset_config('disabled', 'format_'. $pluginname);
\core_plugin_manager::reset_caches();
}
break;
case 'availability':
if($show==0){
set_config('disabled', 1, 'availability_' . $pluginname);
}else{
unset_config('disabled', 'availability_' . $pluginname);
}
\core_plugin_manager::reset_caches();
break;
default:
echo "bad plugin type $plugintype or not taken in charge";
break;
}
}
private static function hideshow_values_check($hideshow,$possiblevalues){
if(!in_array($hideshow, $possiblevalues)){
cli_error(get_string('hideshow_plugin_cli_parametervalues','tool_cmdlinetools',implode(',', $possiblevalues)));
}
}

protected function getArgumentsHelp() {
$help = parent::getArgumentsHelp();
$help .= "\n\n";
$help .= "This command enable to hide show a plugin";
$help .= "\n\nplugintype can be block, mod, assignfeedback, assignsubmission, qtype, qbehaviour, enrol, filter, editor, auth, license, repository, courseformat or avaibility";
return $help;
}
}
43 changes: 43 additions & 0 deletions Moosh/Command/Generic/Request/RequestSelect.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php
/**
* moosh - Moodle Shell
*
* @auhtor 2021 Céline Pervès <[email protected]>
* @copyright Université de Strasbourg unistra.fr
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace Moosh\Command\Generic\Request;

use Moosh\MooshCommand;

class RequestSelect extends MooshCommand {
public function __construct() {
parent::__construct('select', 'request');
$this->addArgument('select_query');
$this->minArguments = 1;
$this->maxArguments = 1;
}

protected function getArgumentsHelp() {
$help = parent::getArgumentsHelp();
$help .= "\n\n";
$help .= "This command enable to make a select query and return resultset into a csv format";
return $help;
}


public function execute() {
global $CFG, $DB;
$selectquery = trim($this->arguments[0]);
cli_writeln("$selectquery");
$results = $DB->get_records_sql($selectquery);
$output = '';
foreach($results as $index=>$result) {
$output.=implode(';',(array) $result)."\n";
}
echo $output;
}
}


64 changes: 64 additions & 0 deletions Moosh/Command/Moodle39/Cache/CacheSet.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?php

/**
* moosh - Moodle Shell
*
* @copyright 2021 unistra {@link http://unistra.fr}
* @author 2021 Céline Perves <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace Moosh\Command\Moodle39\Cache;
use Moosh\MooshCommand;

class CacheSet extends MooshCommand
{
public function __construct() {
parent::__construct('set', 'cache');
$this->addArgument('definition');
$this->addArgument('mapping');
}

public function execute()
{
global $CFG;
require_once($CFG->dirroot.'/cache/locallib.php');
$var_definition=$this->arguments[0];
$var_mappings=$this->arguments[1];
if(!isset($var_definition) || !isset($var_mappings) ){
cli_error('Defintion and mampings are required');
}
$factory = \cache_factory::instance();
list($component, $area) = explode('/', $var_definition, 2);
$config = \cache_config::instance();
$writer = \cache_config_writer::instance();
$writer->update_definitions();
$definition_check = $writer->get_definition_by_id($var_definition);
if (!$definition_check) {
cli_error("$var_definition cache definition not exists");
}
$definition = $factory->create_definition($component, $area);
$possiblestores = $config->get_stores($definition->get_mode(), $definition->get_requirements_bin());

$var_mappings = explode(',',$var_mappings);
$mappings = array();
foreach ($var_mappings as $index => $var_mapping){
// Check mapping is available.
if (array_key_exists($var_mapping, $possiblestores)){
$mappings[$index]= $var_mapping;
}else if(!empty($var_mapping)){
cli_error("Bad store instance name mapping $var_mapping : does not exists or not usable for this cache mode");
}
}
$writer->set_definition_mappings($var_definition, $mappings);
return true;
}

protected function getArgumentsHelp() {
$help = parent::getArgumentsHelp();
$help .= "\n\n";
$help .= "This command enable to attribute cache to specific cache definition";
$help .= "\ne.g moosh -n cache-set core/calendar_subscriptions redisstore";
return $help;
}
}
Loading
Loading