snappymail/integrations/nextcloud/snappymail/lib/Util/SnappyMailHelper.php
google-labs-jules[bot] d22f8d521d Nextcloud 32/33 Compatibility: Remove deprecated API usage
This commit updates the SnappyMail integration app for Nextcloud to support version 32 and the upcoming version 33.

Key changes:
- Updated `info.xml` to allow `max-version="33"`.
- Refactored `AdminSettings`, `Application`, `FetchController`, `PageController`, `Settings` (command), and `InstallStep` to use Dependency Injection instead of the deprecated `\OC::$server` service container.
- Replaced deprecated `OC_User`, `OC_Util` (e.g. `addScript`), and `OC_App` calls with their `OCP` (public API) counterparts or modern equivalents.
- Updated `SnappyMailHelper` to use `\OCP\Server::get()` for static context access where DI is not possible.
- Moved script and style registration from Controllers (using deprecated `Util::addScript`) to templates using `script()` and `style()` helpers.
- Updated `Settings` console command to extend `Symfony\Component\Console\Command\Command` instead of deprecated `OC\Core\Command\Base`.
- Addressed PHP 8.4+ compatibility by adding explicit property types and nullable types where necessary in the integration code.

Co-authored-by: nextgen-networks <21206978+nextgen-networks@users.noreply.github.com>
2026-02-03 16:04:29 +00:00

252 lines
8.1 KiB
PHP

<?php
namespace OCA\SnappyMail\Util;
use OCP\Server;
use OCP\IUserSession;
use OCP\IConfig;
use OCP\IURLGenerator;
use OCP\App\IAppManager;
use OCP\ISession;
use OCP\IGroupManager;
class SnappyMailResponse extends \OCP\AppFramework\Http\Response
{
public function render(): string
{
$data = '';
$i = \ob_get_level();
while ($i--) {
$data .= \ob_get_clean();
}
return $data;
}
}
class SnappyMailHelper
{
public static function loadApp() : void
{
if (\class_exists('RainLoop\\Api')) {
return;
}
// Nextcloud the default spl_autoload_register() not working
\spl_autoload_register(function($sClassName){
$file = SNAPPYMAIL_LIBRARIES_PATH . \strtolower(\strtr($sClassName, '\\', DIRECTORY_SEPARATOR)) . '.php';
if (\is_file($file)) {
include_once $file;
}
});
$_ENV['SNAPPYMAIL_INCLUDE_AS_API'] = true;
// define('APP_VERSION', '0.0.0');
// define('APP_INDEX_ROOT_PATH', __DIR__ . DIRECTORY_SEPARATOR);
// include APP_INDEX_ROOT_PATH.'snappymail/v/'.APP_VERSION.'/include.php';
// define('APP_DATA_FOLDER_PATH', \rtrim(\trim(\OC::$server->getSystemConfig()->getValue('datadirectory', '')), '\\/').'/appdata_snappymail/');
$app_dir = \dirname(\dirname(__DIR__)) . '/app';
require_once $app_dir . '/index.php';
}
public static function startApp(bool $handle = false)
{
static::loadApp();
$oConfig = \RainLoop\Api::Config();
if (false !== \stripos(\php_sapi_name(), 'cli')) {
return;
}
try {
$oActions = \RainLoop\Api::Actions();
if (isset($_GET[$oConfig->Get('security', 'admin_panel_key', 'admin')])) {
$user = Server::get(IUserSession::class)->getUser();
if ($oConfig->Get('security', 'allow_admin_panel', true)
&& $user
&& Server::get(IGroupManager::class)->isAdmin($user->getUID())
&& !$oActions->IsAdminLoggined(false)
) {
$sRand = \MailSo\Base\Utils::Sha1Rand();
if ($oActions->Cacher(null, true)->Set(\RainLoop\KeyPathHelper::SessionAdminKey($sRand), \time())) {
$sToken = \RainLoop\Utils::EncodeKeyValuesQ(array('token', $sRand));
// $oActions->setAdminAuthToken($sToken);
\SnappyMail\Cookies::set('smadmin', $sToken);
}
}
} else {
$doLogin = !$oActions->getMainAccountFromToken(false);
$aCredentials = static::getLoginCredentials();
/*
// NC25+ workaround for Impersonate plugin
// https://github.com/the-djmaze/snappymail/issues/561#issuecomment-1301317723
// https://github.com/nextcloud/server/issues/34935#issuecomment-1302145157
require \OC::$SERVERROOT . '/version.php';
// \OC\SystemConfig
// file_get_contents(\OC::$SERVERROOT . 'config/config.php');
// $CONFIG['version']
if (24 < $OC_Version[0]) {
$ocSession = Server::get(ISession::class);
$ocSession->reopen();
if (!$doLogin && $ocSession['snappymail-uid'] && $ocSession['snappymail-uid'] != $aCredentials[0]) {
// UID changed, Impersonate plugin probably active
$oActions->Logout(true);
$doLogin = true;
}
$ocSession->set('snappymail-uid', $aCredentials[0]);
}
*/
if ($doLogin && $aCredentials[1] && $aCredentials[2]) {
$isOIDC = \str_starts_with($aCredentials[2], 'oidc_login|');
try {
$ocSession = Server::get(ISession::class);
$oAccount = $oActions->LoginProcess($aCredentials[1], $aCredentials[2]);
if (!$isOIDC && $oAccount
&& $oConfig->Get('login', 'sign_me_auto', \RainLoop\Enumerations\SignMeType::DefaultOff) === \RainLoop\Enumerations\SignMeType::DefaultOn
) {
$oActions->SetSignMeToken($oAccount);
}
} catch (\Throwable $e) {
// Login failure, reset password to prevent more attempts
if (!$isOIDC) {
$user = Server::get(IUserSession::class)->getUser();
$sUID = $user ? $user->getUID() : null;
if ($sUID) {
$session = Server::get(ISession::class);
$session['snappymail-passphrase'] = '';
Server::get(IConfig::class)->setUserValue($sUID, 'snappymail', 'passphrase', '');
\SnappyMail\Log::error('Nextcloud', $e->getMessage());
}
}
}
}
}
if ($handle) {
\header_remove('Content-Security-Policy');
\RainLoop\Service::Handle();
// https://github.com/the-djmaze/snappymail/issues/1069
exit;
// return new SnappyMailResponse();
}
} catch (\Throwable $e) {
// Ignore login failure
}
}
// Check if OpenID Connect (OIDC) is enabled and used for login
// https://apps.nextcloud.com/apps/oidc_login
public static function isOIDCLogin() : bool
{
$config = Server::get(IConfig::class);
if ($config->getAppValue('snappymail', 'snappymail-autologin-oidc', false)) {
// Check if the OIDC Login app is enabled
if (Server::get(IAppManager::class)->isEnabledForUser('oidc_login')) {
// Check if session is an OIDC Login
$ocSession = Server::get(ISession::class);
if ($ocSession->get('is_oidc')) {
// IToken->getPassword() ???
if ($ocSession->get('oidc_access_token')) {
return true;
}
\SnappyMail\Log::debug('Nextcloud', 'OIDC access_token missing');
} else {
\SnappyMail\Log::debug('Nextcloud', 'No OIDC login');
}
} else {
\SnappyMail\Log::debug('Nextcloud', 'OIDC login disabled');
}
}
return false;
}
private static function getLoginCredentials() : array
{
$user = Server::get(IUserSession::class)->getUser();
$sUID = $user ? $user->getUID() : '';
$config = Server::get(IConfig::class);
$ocSession = Server::get(ISession::class);
if (!$sUID) {
return ['', '', ''];
}
// If the user has set credentials for SnappyMail in their personal settings,
// this has the first priority.
$sEmail = $config->getUserValue($sUID, 'snappymail', 'snappymail-email');
$sPassword = $config->getUserValue($sUID, 'snappymail', 'passphrase')
?: $config->getUserValue($sUID, 'snappymail', 'snappymail-password');
if ($sEmail && $sPassword) {
$sPassword = static::decodePassword($sPassword, \md5($sEmail));
if ($sPassword) {
return [$sUID, $sEmail, $sPassword];
} else {
\SnappyMail\Log::debug('Nextcloud', 'decodePassword failed for getUserValue');
}
}
// If the current user ID is identical to login ID (not valid when using account switching),
// this has the second priority.
// Note: $ocSession array access is supported but deprecated? ISession implements ArrayAccess.
if ($ocSession['snappymail-nc-uid'] == $sUID) {
// If OpenID Connect (OIDC) is enabled and used for login, use this.
if (static::isOIDCLogin()) {
$sEmail = $config->getUserValue($sUID, 'settings', 'email');
return [$sUID, $sEmail, "oidc_login|{$sUID}"];
}
// Only use the user's password in the current session if they have
// enabled auto-login using Nextcloud username or email address.
$sEmail = '';
$sPassword = '';
if ($config->getAppValue('snappymail', 'snappymail-autologin', false)) {
$sEmail = $sUID;
$sPassword = $ocSession['snappymail-passphrase'];
} else if ($config->getAppValue('snappymail', 'snappymail-autologin-with-email', false)) {
$sEmail = $config->getUserValue($sUID, 'settings', 'email');
$sPassword = $ocSession['snappymail-passphrase'];
} else {
\SnappyMail\Log::debug('Nextcloud', 'snappymail-autologin is off');
}
if ($sPassword) {
return [$sUID, $sEmail, static::decodePassword($sPassword, $sUID)];
}
} else {
\SnappyMail\Log::debug('Nextcloud', "snappymail-nc-uid mismatch '{$ocSession['snappymail-nc-uid']}' != '{$sUID}'");
}
return [$sUID, '', ''];
}
public static function getAppUrl() : string
{
return Server::get(IURLGenerator::class)->linkToRoute('snappymail.page.appGet');
}
public static function normalizeUrl(string $sUrl) : string
{
$sUrl = \rtrim(\trim($sUrl), '/\\');
if ('.php' !== \strtolower(\substr($sUrl, -4))) {
$sUrl .= '/';
}
return $sUrl;
}
public static function encodePassword(string $sPassword, string $sSalt) : string
{
static::loadApp();
return \SnappyMail\Crypt::EncryptUrlSafe($sPassword, $sSalt);
}
public static function decodePassword(string $sPassword, string $sSalt) : ?\SnappyMail\SensitiveString
{
static::loadApp();
$result = \SnappyMail\Crypt::DecryptUrlSafe($sPassword, $sSalt);
return $result ? new \SnappyMail\SensitiveString($result) : null;
}
}