Apostila 3 — Curso Noções Básicas sobre a Plataforma Moodle

NOÇÕES BÁSICAS SOBRE A PLATAFORMA MOODLE

Integrações, Banco de Dados e Práticas Avançadas 

Manipulando o Banco de Dados com o Moodle DB API

  

O banco de dados é um componente central na arquitetura do Moodle, armazenando informações cruciais como usuários, cursos, atividades, notas, permissões e configurações. Ao contrário do uso direto de comandos SQL, o Moodle promove uma abordagem mais segura e consistente por meio de sua API de banco de dados, referida como $DB API. Essa camada de abstração garante compatibilidade com múltiplos sistemas de gerenciamento de banco de dados e protege a integridade dos dados, evitando injeções SQL e erros de sintaxe. Além disso, o Moodle oferece uma ferramenta visual chamada XMLDB Editor para definição e atualização estruturada de tabelas.

1. Estrutura do Banco de Dados do Moodle

A estrutura do banco de dados do Moodle é complexa, com centenas de tabelas inter-relacionadas. Cada componente da plataforma, como usuários, cursos e módulos, possui tabelas específicas, além de relacionamentos definidos com o core.

1.1 Organização das Tabelas

As tabelas do Moodle seguem convenções padronizadas de nomenclatura:

  • mdl_user: armazena informações de usuários.
  • mdl_course: contém os dados dos cursos.
  • mdl_config: guarda configurações globais do site.
  • mdl_grade_items, mdl_grade_grades: estrutura de avaliação.
  • mdl_logstore_standard_log: registros de ações e eventos.

A sigla mdl_ é o prefixo padrão, mas pode variar dependendo da instalação. Cada módulo ou plugin pode criar suas próprias tabelas, que são automaticamente gerenciadas pelo sistema durante a instalação, atualização ou desinstalação do componente.

1.2 Chaves Primárias e Estrangeiras

O Moodle segue boas práticas de modelagem de dados, utilizando chaves primárias e estrangeiras para garantir a integridade referencial. A maioria das tabelas utiliza o campo id como chave primária, e relacionamentos são estabelecidos por meio de campos como userid, courseid, contextid, entre outros.

2. Uso da $DB API

A classe global $DB, instanciada a partir de moodle_database, é o principal meio de interação com o banco de dados no Moodle. Ela substitui comandos SQL diretos por métodos seguros e padronizados.

2.1 Leitura de Dados

$usuario = $DB->get_record('user', ['id' => 5]);

echo $usuario->firstname;

O método get_record() retorna uma linha da tabela especificada. Para

múltiplos registros, usa-se get_records():

$usuarios = $DB->get_records('user', ['confirmed' => 1]);

2.2 Inserção de Dados

$novo = new stdClass();

$novo->firstname = 'João';

$novo->lastname = 'Silva';

$novo->email = 'joao@example.com';

$DB->insert_record('user', $novo);

O método insert_record() adiciona um novo registro à tabela indicada. Retorna o id inserido, se necessário.

2.3 Atualização de Dados

$usuario = $DB->get_record('user', ['id' => 5]);

$usuario->lastname = 'Oliveira';

$DB->update_record('user', $usuario);

Atualizações exigem que o objeto fornecido contenha o campo id (chave primária) preenchido. O método update_record() substitui os valores existentes pelos novos.

2.4 Exclusão de Dados

$DB->delete_records('user', ['id' => 5]);

As exclusões também devem ser feitas com cautela, pois não há “lixeira” ou recuperação automática. Em muitos casos, recomenda-se apenas desativar registros via flags (como deleted = 1).

3. Criando e Atualizando Tabelas via XMLDB

3.1 O que é o XMLDB

O XMLDB é o sistema interno do Moodle para definição e gerenciamento de tabelas de banco de dados. Ele utiliza arquivos XML localizados no diretório db/ dos plugins para definir a estrutura das tabelas necessárias. O Moodle lê esses arquivos e aplica as alterações usando sua própria camada de abstração, garantindo compatibilidade com diferentes SGBDs (MySQL, PostgreSQL, MSSQL, Oracle).

3.2 Criando o Arquivo install.xml

Durante o desenvolvimento de um plugin, o arquivo install.xml deve ser criado com a ferramenta XMLDB Editor:

  • Acessar: Administração do site > Desenvolvimento > Editor XMLDB
  • Selecionar o plugin desejado
  • Adicionar nova tabela com campos, índices e chaves
  • Salvar e gerar o arquivo XML em /db/install.xml

Exemplo de definição simples:

<TABLE NAME="example_table" COMMENT="Tabela de exemplo">

  <FIELDS>

    <FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>

    <FIELD NAME="name" TYPE="char" LENGTH="255" NOTNULL="true"/>

    <FIELD NAME="timecreated" TYPE="int" LENGTH="10" NOTNULL="true"/>

  </FIELDS>

  <KEYS>

    <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

  </KEYS>

</TABLE>

3.3 Atualizações com upgrade.php

Para alterações em versões futuras, o arquivo upgrade.php dentro da pasta db/ é utilizado. Ele contém scripts condicionais que alteram a estrutura conforme o número da versão do plugin.

if ($oldversion < 2025061301) {

    $table

= new xmldb_table('example_table');

    $field = new xmldb_field('description', XMLDB_TYPE_TEXT, null, null, false);

    if (!field_exists($table, $field)) {

        add_field($table, $field);

    }

    upgrade_plugin_savepoint(true, 2025061301, 'local', 'exemplo');

}

Esse mecanismo evita que estruturas já existentes sejam recriadas e garante a consistência dos dados ao longo das atualizações.

Considerações Finais

A manipulação de banco de dados no Moodle é segura, extensível e eficiente graças ao uso da $DB API e do sistema XMLDB. Essa abordagem abstrai os detalhes de implementação de diferentes SGBDs e proporciona uma camada uniforme para leitura, inserção, atualização e exclusão de dados. Além disso, o uso de arquivos XML e scripts de atualização garante a manutenção adequada das estruturas de dados ao longo do ciclo de vida de um plugin.

Desenvolvedores que desejam criar plugins, relatórios personalizados ou funcionalidades avançadas no Moodle devem dominar o uso da $DB API e o funcionamento do XMLDB, pois esses recursos formam a espinha dorsal da persistência de dados na plataforma.

Referências Bibliográficas

  • MOODLE DEV. Database API. MoodleDev.io. Disponível em: https://moodledev.io/docs/apis/core/dml
  • MOODLE DEV. XMLDB Editor Guide. Disponível em: https://moodledev.io/docs/apis/core/ddl
  • ITALIANO, Marco A. Programando com Moodle: Desenvolvendo plugins para o maior LMS open source. São Paulo: Novatec, 2020.
  • CACCIA, Marcelo. Desenvolvimento de sistemas para EAD com Moodle. Rio de Janeiro: Ciência Moderna, 2019.
  • GITHUB. Moodle Source Code. Disponível em: https://github.com/moodle/moodle


Webservices e Integrações com Sistemas Externos no Moodle
Ativação, Configuração, Desenvolvimento e Integração REST/SOAP

 

A conectividade entre plataformas educacionais e sistemas externos tornou-se essencial para a interoperabilidade de dados, automação de processos e melhoria da experiência do usuário. O Moodle, como sistema de gestão de aprendizagem (LMS) open source, disponibiliza um conjunto robusto de webservices que permite sua integração com outros sistemas por meio de chamadas REST, SOAP ou XML-RPC. Esses recursos possibilitam, por exemplo, sincronizar matrículas, enviar notas, integrar sistemas acadêmicos, ERPs ou portais educacionais.

1. Ativando e Configurando Webservices no Moodle

Antes de utilizar os webservices do Moodle, é necessário ativar essa funcionalidade e configurar os

serviços e permissões correspondentes. Essa configuração é feita exclusivamente por administradores do sistema.

1.1 Ativando os Webservices

Para ativar a funcionalidade:

1.     Acesse o painel administrativo:
Administração do site > Avançado > Web services > Gerenciar serviços

2.     Ative o protocolo desejado:

o    REST (mais comum e compatível com diversas linguagens)

o    SOAP

o    XML-RPC

Além disso, é necessário habilitar a API web:

  • Administração do site > Segurança > Políticas do site
    Marque a opção “Habilitar web services para usuários”.

1.2 Criando um Token de Acesso

Após ativar os protocolos, é preciso gerar um token que autentica as requisições externas:

1.     Crie um usuário específico para o serviço ou utilize um usuário existente.

2.     Atribua a ele as permissões adequadas (geralmente o papel de web service user).

3.     Em Administração do site > Web services > Gerenciar tokens, crie um token vinculando o usuário, o serviço e o método.

Esse token será utilizado em chamadas HTTP como identificador seguro de quem está solicitando a operação.

2. Criando Webservices Personalizados no Moodle

Além dos serviços já fornecidos pelo núcleo do Moodle (como core_user_get_users, core_course_get_courses, core_enrol_get_users_courses), é possível criar webservices personalizados para atender necessidades específicas.

2.1 Etapas para Criação de Função Personalizada

a) Definir a função em um plugin (por exemplo, local_customapi)

Dentro do arquivo /db/services.php, declare os serviços e métodos:

$functions = [

    'local_customapi_get_user_info' => [

        'classname' => 'local_customapi\external\get_user_info',

        'methodname' => 'execute',

        'classpath' => '',

        'description' => 'Retorna informações do usuário',

        'type' => 'read',

        'ajax' => true,

        'capabilities' => 'moodle/user:viewhiddendetails',

    ],

];

b) Criar a classe responsável no diretório /classes/external/:

namespace local_customapi\external;

use external_api;

use external_function_parameters;

use external_value;

use external_single_structure;

class get_user_info extends external_api {

    public static function execute_parameters() {

        return new external_function_parameters([

            'userid' => new external_value(PARAM_INT, 'ID do usuário')

        ]);

    }

    public static function execute($userid) {

        global $DB;

        $user =

$DB->get_record('user', ['id' => $userid], '*', MUST_EXIST);

        return [

            'firstname' => $user->firstname,

            'lastname' => $user->lastname,

            'email' => $user->email

        ];

    }

    public static function execute_returns() {

        return new external_single_structure([

            'firstname' => new external_value(PARAM_TEXT, 'Nome'),

            'lastname' => new external_value(PARAM_TEXT, 'Sobrenome'),

            'email' => new external_value(PARAM_TEXT, 'Email')

        ]);

    }

}

c) Registrar o serviço

  • Acesse: Administração > Web services > Gerenciar serviços
  • Crie um novo serviço, marque como "personalizado", e adicione a função definida.
  • Gere um token para acesso ao serviço.

3. Integração com Aplicações Externas (REST/SOAP)

O Moodle é compatível com múltiplos protocolos de comunicação para webservices, sendo REST e SOAP os mais utilizados.

3.1 Integração via REST

É o método mais leve e compatível com diversas linguagens (JavaScript, Python, PHP, etc.).

Exemplo de chamada REST via curl:

curl -X POST "https://meumoodle.com/webservice/rest/server.php" \

-d "wstoken=abcdef1234567890" \

-d "wsfunction=core_user_get_users" \

-d "moodlewsrestformat=json" \

--data-urlencode 'criteria[0][key]=email' \

--data-urlencode 'criteria[0][value]=joao@example.com'

A resposta será em JSON e pode ser tratada facilmente pela aplicação cliente.

3.2 Integração via SOAP

SOAP é mais estruturado e baseado em XML, ideal para ambientes corporativos legados. O Moodle gera o WSDL automaticamente:

  • URL: https://meumoodle.com/webservice/soap/server.php?wsdl=1

Um cliente SOAP pode consumir esse WSDL e executar funções registradas, embora seja menos comum no contexto atual dominado por RESTful APIs.

Boas Práticas de Integração

  • Segurança: use HTTPS obrigatoriamente. Nunca exponha tokens publicamente.
  • Validação de dados: sempre defina parâmetros de entrada com external_function_parameters, evitando entradas maliciosas.
  • Logs e auditoria: registre chamadas relevantes e trate erros de forma clara.
  • Limitação de escopo: crie serviços com permissões mínimas necessárias.
  • Versionamento: evite mudanças abruptas em APIs consumidas por terceiros.

Considerações Finais

Os webservices do Moodle oferecem uma infraestrutura completa para integração com sistemas externos. Seja para automatizar processos administrativos, sincronizar bases

de dados ou criar experiências de aprendizagem omnicanal, as APIs do Moodle garantem flexibilidade, segurança e aderência a padrões modernos de interoperabilidade.

O suporte a protocolos REST e SOAP, combinado com a possibilidade de definir funções personalizadas, torna o Moodle um sistema altamente conectável e adaptável.

Ao utilizar os webservices de forma planejada e com boas práticas, desenvolvedores podem criar soluções educacionais complexas e integradas, maximizando o valor pedagógico da plataforma.

Referências Bibliográficas

  • MOODLE DEV. Web services. MoodleDev.io. Disponível em: https://moodledev.io/docs/apis/core/webservices
  • MOODLE HQ. REST and SOAP Documentation. MoodleDocs. Disponível em: https://docs.moodle.org/en/Web_services
  • ITALIANO, Marco A. Programando com Moodle: Desenvolvendo plugins para o maior LMS open source. São Paulo: Novatec, 2020.
  • CACCIA, Marcelo. Desenvolvimento de sistemas para EAD com Moodle. Rio de Janeiro: Ciência Moderna, 2019.
  • GITHUB. Moodle Source Code. Disponível em: https://github.com/moodle/moodle


Segurança, Performance e Atualizações no Moodle
Boas Práticas de Segurança, Otimização de Desempenho e Procedimentos de Atualização Segura

 

O Moodle, como plataforma de gestão de aprendizagem (LMS) de código aberto, é amplamente utilizado por instituições educacionais, empresas e organizações governamentais. Para garantir sua integridade, eficiência e sustentabilidade, é fundamental observar aspectos críticos como segurança, performance e atualizações. Uma administração negligente nesses pilares pode comprometer a confidencialidade dos dados, a experiência do usuário e a continuidade dos serviços educacionais.

1. Boas Práticas de Segurança

A segurança no Moodle é estruturada em torno de permissões granulares, controle de papéis e proteção contra vulnerabilidades comuns em aplicações web. A plataforma oferece um sistema robusto para limitar o que cada usuário pode ver ou fazer, além de mecanismos internos para mitigar ameaças como injeções, CSRF e ataques por força bruta.

1.1 Capabilities e Roles

O Moodle utiliza um sistema baseado em capabilities (capacidades) e roles (papéis). Cada ação sensível na plataforma está vinculada a uma capability, como moodle/course:manageactivities ou mod/forum:replypost. Os papéis (como aluno, professor ou administrador) são compostos por conjuntos dessas capacidades.

  • As permissões são atribuídas por contexto (curso,
  • sistema, categoria).
  • O administrador pode customizar ou criar novos papéis com permissões específicas.
  • O uso correto desse sistema evita acesso indevido a funcionalidades críticas.

É recomendável evitar dar permissões administrativas a usuários comuns e revisar regularmente os papéis e suas capabilities para garantir alinhamento com as políticas institucionais.

1.2 Proteção contra CSRF

O Moodle implementa um sistema robusto de proteção contra Cross-Site Request Forgery (CSRF), utilizando sesskeys (chaves de sessão) em ações que modificam dados. Essas chaves garantem que somente usuários autenticados e autorizados possam realizar requisições sensíveis.

Todo formulário ou link que executa uma ação de escrita deve incluir a função require_sesskey() e o parâmetro sesskey=....

require_sesskey();

Além disso, é essencial validar todos os parâmetros recebidos por scripts externos com required_param() ou optional_param() utilizando constantes de segurança como PARAM_INT, PARAM_TEXT, PARAM_ALPHANUM, entre outras.

1.3 Outras Práticas de Segurança

  • HTTPS obrigatório para toda a plataforma.
  • Autenticação multifator (MFA), especialmente para administradores.
  • Limitação de tentativas de login e reCAPTCHA em formulários públicos.
  • Atualizações regulares para correção de vulnerabilidades conhecidas.
  • Monitoramento de logs em mdl_logstore_standard_log para auditoria de ações.

2. Cache, Performance e Escalabilidade

O Moodle é altamente escalável, mas depende de boas práticas de cache, configuração de servidores e otimização de código para oferecer uma experiência fluida, especialmente em ambientes com milhares de usuários simultâneos.

2.1 Sistema de Cache

O Moodle possui um sistema de cache interno estruturado em camadas. Os tipos principais incluem:

  • Application Cache: usado para acelerar o carregamento de dados não críticos.
  • Session Cache: específico de cada usuário e sessão.
  • Request Cache: válido apenas durante uma requisição HTTP.
  • Static Cache: armazenado na memória durante a execução do PHP.

A configuração é realizada em:
Administração do site > Desenvolvimento > Cache > Configuração dos caches

Os backends recomendados são:

  • Memcached ou Redis para alto desempenho em ambientes grandes.
  • File cache em instalações menores (armazenado no diretório de dados).

2.2 Otimização de Performance

  • Ativar agregação e minificação de CSS e JS.
  • Reduzir o número de
  • plugins ativos.
  • Usar temas leves com menos dependências visuais.
  • Utilizar aceleração PHP com OPcache.
  • Executar o script cron.php regularmente para agendar tarefas.
  • Realizar consultas otimizadas com a API $DB, evitando get_records_sql() com joins complexos.

2.3 Escalabilidade Horizontal

Para ambientes corporativos e universidades com milhares de acessos simultâneos, o Moodle pode ser distribuído em múltiplos servidores com:

  • Balanceadores de carga (load balancers).
  • Clusters de banco de dados (MySQL Replication, Galera Cluster).
  • Armazenamento de sessão compartilhado via Redis ou banco de dados.
  • Sistema de arquivos compartilhado (ex: NFS) para diretório de dados.

3. Atualização Segura de Plugins e do Núcleo

Manter o Moodle e seus componentes atualizados é essencial para garantir segurança, compatibilidade e acesso a novos recursos. A atualização, no entanto, deve seguir um processo rigoroso para evitar falhas ou perda de dados.

3.1 Atualização do Núcleo

Procedimento recomendado:

1.     Backup completo da base de dados e do diretório moodledata.

2.     Verificação de requisitos mínimos da nova versão (PHP, banco, extensões).

3.     Substituir os arquivos do núcleo por uma nova versão estável.

4.     Preservar os arquivos de config.php e o diretório moodledata.

5.     Acessar a interface administrativa para atualizar o banco de dados.

6.     Executar admin/cli/upgrade.php para atualizações silenciosas via terminal, se preferível.

As versões estáveis estão disponíveis em:
https://download.moodle.org/

3.2 Atualização de Plugins

Plugins devem ser atualizados com atenção redobrada:

  • Verifique compatibilidade com a versão atual do núcleo.
  • Leia notas de versão e changelogs fornecidos pelo desenvolvedor.
  • Execute o script de upgrade para aplicar mudanças no banco:
    admin/cli/upgrade.php
  • Teste extensivamente em ambiente de homologação antes de aplicar em produção.

Evite manter plugins não utilizados ou abandonados, pois eles podem representar riscos de segurança ou instabilidade.

Considerações Finais

Segurança, desempenho e atualização são os pilares da manutenção eficiente do Moodle em ambientes de produção. O uso consciente de capabilities, a proteção contra ataques web e a aplicação rigorosa das boas práticas de programação garantem um sistema confiável e resiliente. Simultaneamente, a configuração adequada de cache, a otimização de código e a escalabilidade

estruturada asseguram que a plataforma suporte grandes volumes de usuários com fluidez. Por fim, manter o Moodle e seus plugins atualizados é essencial para acompanhar evoluções tecnológicas e prevenir vulnerabilidades.

Administradores e desenvolvedores que seguem essas diretrizes estarão aptos a oferecer experiências educacionais online estáveis, seguras e sustentáveis.

Referências Bibliográficas

  • MOODLE DEV. Security Guidelines. Disponível em: https://moodledev.io/docs/guides/security
  • MOODLE DEV. Caching in Moodle. Disponível em: https://moodledev.io/docs/apis/core/cache
  • MOODLE DOCS. Upgrading Moodle. Disponível em: https://docs.moodle.org/en/Upgrading
  • ITALIANO, Marco A. Programando com Moodle: Desenvolvendo plugins para o maior LMS open source. São Paulo: Novatec, 2020.
  • CACCIA, Marcelo. Desenvolvimento de sistemas para EAD com Moodle. Rio de Janeiro: Ciência Moderna, 2019.
  • MOODLE HQ. Performance recommendations. Disponível em: https://docs.moodle.org/en/Performance_recommendations

Parte superior do formulário

Parte inferior do formulário

Voltar