PNG  IHDRxsBIT|d pHYs+tEXtSoftwarewww.inkscape.org<,tEXtComment File Manager

File Manager

Path: /opt/cloudlinux/venv/lib/python3.11/site-packages/clcagefslib/webisolation/crontab/

Viewing File: libhooks.py

# -*- coding: utf-8 -*-
#
# Copyright © Cloud Linux GmbH & Cloud Linux Software, Inc 2010-2025 All Rights Reserved
#
# Licensed under CLOUD LINUX LICENSE AGREEMENT
# http://cloudlinux.com/docs/LICENCE.TXT
#
"""Hook integration functions for crontab operations."""

import logging
import shlex
import subprocess

from clcommon.cpapi import userdomains

from .constants import ISOLATION_WRAPPER
from .parser import parse_crontab_structure, write_crontab_structure
from .structure import ParsedCrontabLine

CRONTAB_BIN = "/usr/bin/crontab"

logger = logging.getLogger(__name__)


def migrate_crontab_docroot(
    username: str,
    old_docroot: str,
    new_docroot: str,
) -> bool:
    """
    Migrate crontab entries from old document root to new document root.

    When a document root path changes (e.g., domain rename, docroot move),
    this function updates all crontab entries that reference the old path
    to use the new path instead.

    Args:
        username: Unix username whose crontab to migrate
        old_docroot: Previous document root path
        new_docroot: New document root path

    Returns:
        bool: True if migration was successful, False if no changes needed or error

    Raises:
        Exception: If crontab operations fail critically
    """
    # Get current crontab for the user
    list_result = subprocess.run(
        [CRONTAB_BIN, "-u", username, "-l"],
        capture_output=True,
    )

    # No existing crontab - nothing to migrate
    if list_result.returncode != 0:
        logger.debug(
            "No crontab to migrate for user %s (returncode: %d)",
            username,
            list_result.returncode,
        )
        return False

    existing_data = list_result.stdout
    if not existing_data:
        logger.debug("Empty crontab for user %s, nothing to migrate", username)
        return False

    # Parse existing crontab into structure
    structure = parse_crontab_structure(existing_data)

    # Check if old docroot section exists
    if old_docroot not in structure.docroot_sections:
        logger.debug(
            "No crontab entries found for old docroot %s for user %s",
            old_docroot,
            username,
        )
        return False

    # Migrate: move entries from old docroot to new docroot
    old_entries = structure.docroot_sections.pop(old_docroot)

    # Update wrapper commands in the entries to use new docroot
    migrated_entries = []
    for entry in old_entries:
        if isinstance(entry, ParsedCrontabLine):
            # Get the clean command (without wrapper)
            clean_command = entry.get_clean_command()
            has_newline = clean_command.endswith(b"\n")
            command_str = clean_command.rstrip(b"\n").decode("utf-8", errors="replace")

            # Rebuild with new docroot
            quoted_command = shlex.quote(command_str)
            prefix_parts = shlex.join([ISOLATION_WRAPPER, new_docroot, "bash", "-c"])
            wrapped_command_str = f"{prefix_parts} {quoted_command}"
            wrapped_command = wrapped_command_str.encode("utf-8")
            if has_newline:
                wrapped_command += b"\n"

            migrated_entries.append(
                ParsedCrontabLine(schedule=entry.schedule, command=wrapped_command)
            )
        else:
            # Keep comments as-is
            migrated_entries.append(entry)

    # Add migrated entries to new docroot section (merge with existing if any)
    if new_docroot in structure.docroot_sections:
        structure.docroot_sections[new_docroot].extend(migrated_entries)
    else:
        structure.docroot_sections[new_docroot] = migrated_entries

    # Write updated crontab
    modified_data = write_crontab_structure(structure)

    save_result = subprocess.run(
        [CRONTAB_BIN, "-u", username, "-"],
        input=modified_data,
        capture_output=True,
    )

    if save_result.returncode != 0:
        logger.error(
            "Failed to save migrated crontab for user %s: %s",
            username,
            save_result.stderr.decode("utf-8", errors="replace"),
        )
        return False

    logger.info(
        "Successfully migrated crontab entries for user %s from %s to %s",
        username,
        old_docroot,
        new_docroot,
    )
    return True


def cleanup_stale_crontab_sections(
    username: str,
) -> bool:
    """
    Remove crontab sections for docroots that no longer exist.

    After a domain is deleted, this function cleans up crontab entries
    for docroots that are no longer valid (not in the current domain list).

    Args:
        username: Unix username whose crontab to clean up

    Returns:
        bool: True if cleanup was performed, False if no changes needed

    Raises:
        Exception: If crontab operations fail critically
    """
    # Get current valid docroots from userdomains
    valid_docroots = {docroot for _, docroot in userdomains(username)}

    # Get current crontab for the user
    list_result = subprocess.run(
        [CRONTAB_BIN, "-u", username, "-l"],
        capture_output=True,
    )

    # No existing crontab - nothing to clean
    if list_result.returncode != 0:
        logger.debug(
            "No crontab to clean for user %s (returncode: %d)",
            username,
            list_result.returncode,
        )
        return False

    existing_data = list_result.stdout
    if not existing_data:
        logger.debug("Empty crontab for user %s, nothing to clean", username)
        return False

    structure = parse_crontab_structure(existing_data)
    stale_docroots = [
        docroot for docroot in structure.docroot_sections.keys() if docroot not in valid_docroots
    ]

    if not stale_docroots:
        logger.debug(
            "No stale crontab sections found for user %s",
            username,
        )
        return False

    for stale_docroot in stale_docroots:
        logger.info(
            "Removing stale crontab section for user %s, docroot: %s",
            username,
            stale_docroot,
        )
        del structure.docroot_sections[stale_docroot]

    modified_data = write_crontab_structure(structure)

    save_result = subprocess.run(
        [CRONTAB_BIN, "-u", username, "-"],
        input=modified_data,
        capture_output=True,
    )

    if save_result.returncode != 0:
        logger.error(
            "Failed to save cleaned crontab for user %s: %s",
            username,
            save_result.stderr.decode("utf-8", errors="replace"),
        )
        return False

    logger.info(
        "Successfully cleaned up %d stale crontab section(s) for user %s: %s",
        len(stale_docroots),
        username,
        ", ".join(stale_docroots),
    )
    return True
b IDATxytVսϓ22 A@IR :hCiZ[v*E:WũZA ^dQeQ @ !jZ'>gsV仿$|?g)&x-EIENT ;@xT.i%-X}SvS5.r/UHz^_$-W"w)Ɗ/@Z &IoX P$K}JzX:;` &, ŋui,e6mX ԵrKb1ԗ)DADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADADA݀!I*]R;I2$eZ#ORZSrr6mteffu*((Pu'v{DIߔ4^pIm'77WEEE;vƎ4-$]'RI{\I&G :IHJ DWBB=\WR޽m o$K(V9ABB.}jѢv`^?IOȅ} ڶmG}T#FJ`56$-ھ}FI&v;0(h;Б38CӧOWf!;A i:F_m9s&|q%=#wZprrrla A &P\\СC[A#! {olF} `E2}MK/vV)i{4BffV\|ۭX`b@kɶ@%i$K z5zhmX[IXZ` 'b%$r5M4º/l ԃߖxhʔ)[@=} K6IM}^5k㏷݆z ΗÿO:gdGBmyT/@+Vɶ纽z񕏵l.y޴it뭷zV0[Y^>Wsqs}\/@$(T7f.InݺiR$푔n.~?H))\ZRW'Mo~v Ov6oԃxz! S,&xm/yɞԟ?'uaSѽb,8GלKboi&3t7Y,)JJ c[nzӳdE&KsZLӄ I?@&%ӟ۶mSMMњ0iؐSZ,|J+N ~,0A0!5%Q-YQQa3}$_vVrf9f?S8`zDADADADADADADADADAdqP,تmMmg1V?rSI꒟]u|l RCyEf٢9 jURbztѰ!m5~tGj2DhG*{H9)꒟ר3:(+3\?/;TUݭʴ~S6lڧUJ*i$d(#=Yݺd{,p|3B))q:vN0Y.jkק6;SɶVzHJJЀ-utѹսk>QUU\޲~]fFnK?&ߡ5b=z9)^|u_k-[y%ZNU6 7Mi:]ۦtk[n X(e6Bb."8cۭ|~teuuw|ήI-5"~Uk;ZicEmN/:]M> cQ^uiƞ??Ңpc#TUU3UakNwA`:Y_V-8.KKfRitv޲* 9S6ֿj,ՃNOMߤ]z^fOh|<>@Å5 _/Iu?{SY4hK/2]4%it5q]GGe2%iR| W&f*^]??vq[LgE_3f}Fxu~}qd-ږFxu~I N>\;͗O֊:̗WJ@BhW=y|GgwܷH_NY?)Tdi'?խwhlmQi !SUUsw4kӺe4rfxu-[nHtMFj}H_u~w>)oV}(T'ebʒv3_[+vn@Ȭ\S}ot}w=kHFnxg S 0eޢm~l}uqZfFoZuuEg `zt~? b;t%>WTkķh[2eG8LIWx,^\thrl^Ϊ{=dž<}qV@ ⠨Wy^LF_>0UkDuʫuCs$)Iv:IK;6ֲ4{^6եm+l3>݆uM 9u?>Zc }g~qhKwڭeFMM~pМuqǿz6Tb@8@Y|jx](^]gf}M"tG -w.@vOqh~/HII`S[l.6nØXL9vUcOoB\xoǤ'T&IǍQw_wpv[kmO{w~>#=P1Pɞa-we:iǏlHo׈꒟f9SzH?+shk%Fs:qVhqY`jvO'ρ?PyX3lх]˾uV{ݞ]1,MzYNW~̈́ joYn}ȚF߾׮mS]F z+EDxm/d{F{-W-4wY듏:??_gPf ^3ecg ҵs8R2מz@TANGj)}CNi/R~}c:5{!ZHӋӾ6}T]G]7W6^n 9*,YqOZj:P?Q DFL|?-^.Ɵ7}fFh׶xe2Pscz1&5\cn[=Vn[ĶE鎀uˌd3GII k;lNmشOuuRVfBE]ۣeӶu :X-[(er4~LHi6:Ѻ@ԅrST0trk%$Č0ez" *z"T/X9|8.C5Feg}CQ%͞ˣJvL/?j^h&9xF`њZ(&yF&Iݻfg#W;3^{Wo^4'vV[[K';+mӍִ]AC@W?1^{එyh +^]fm~iԵ]AB@WTk̏t uR?l.OIHiYyԶ]Aˀ7c:q}ힽaf6Z~қm(+sK4{^6}T*UUu]n.:kx{:2 _m=sAߤU@?Z-Vކеz왍Nэ{|5 pڶn b p-@sPg]0G7fy-M{GCF'%{4`=$-Ge\ eU:m+Zt'WjO!OAF@ik&t݆ϥ_ e}=]"Wz_.͜E3leWFih|t-wZۍ-uw=6YN{6|} |*={Ѽn.S.z1zjۻTH]흾 DuDvmvK.`V]yY~sI@t?/ϓ. m&["+P?MzovVЫG3-GRR[(!!\_,^%?v@ҵő m`Y)tem8GMx.))A]Y i`ViW`?^~!S#^+ѽGZj?Vģ0.))A꨷lzL*]OXrY`DBBLOj{-MH'ii-ϰ ok7^ )쭡b]UXSְmռY|5*cֽk0B7镹%ڽP#8nȎq}mJr23_>lE5$iwui+ H~F`IjƵ@q \ @#qG0".0" l`„.0! ,AQHN6qzkKJ#o;`Xv2>,tێJJ7Z/*A .@fفjMzkg @TvZH3Zxu6Ra'%O?/dQ5xYkU]Rֽkق@DaS^RSּ5|BeHNN͘p HvcYcC5:y #`οb;z2.!kr}gUWkyZn=f Pvsn3p~;4p˚=ē~NmI] ¾ 0lH[_L hsh_ғߤc_њec)g7VIZ5yrgk̞W#IjӪv>՞y睝M8[|]\շ8M6%|@PZڨI-m>=k='aiRo-x?>Q.}`Ȏ:Wsmu u > .@,&;+!!˱tﭧDQwRW\vF\~Q7>spYw$%A~;~}6¾ g&if_=j,v+UL1(tWake:@Ș>j$Gq2t7S?vL|]u/ .(0E6Mk6hiۺzښOrifޱxm/Gx> Lal%%~{lBsR4*}{0Z/tNIɚpV^#Lf:u@k#RSu =S^ZyuR/.@n&΃z~B=0eg뺆#,Þ[B/?H uUf7y Wy}Bwegל`Wh(||`l`.;Ws?V@"c:iɍL֯PGv6zctM̠':wuW;d=;EveD}9J@B(0iհ bvP1{\P&G7D޴Iy_$-Qjm~Yrr&]CDv%bh|Yzni_ˆR;kg}nJOIIwyuL}{ЌNj}:+3Y?:WJ/N+Rzd=hb;dj͒suݔ@NKMԄ jqzC5@y°hL m;*5ezᕏ=ep XL n?מ:r`۵tŤZ|1v`V뽧_csج'ߤ%oTuumk%%%h)uy]Nk[n 'b2 l.=͜E%gf$[c;s:V-͞WߤWh-j7]4=F-X]>ZLSi[Y*We;Zan(ӇW|e(HNNP5[= r4tP &0<pc#`vTNV GFqvTi*Tyam$ߏWyE*VJKMTfFw>'$-ؽ.Ho.8c"@DADADADADADADADADA~j*֘,N;Pi3599h=goضLgiJ5փy~}&Zd9p֚ e:|hL``b/d9p? fgg+%%hMgXosج, ΩOl0Zh=xdjLmhݻoO[g_l,8a]٭+ӧ0$I]c]:粹:Teꢢ"5a^Kgh,&= =՟^߶“ߢE ܹS J}I%:8 IDAT~,9/ʃPW'Mo}zNƍ쨓zPbNZ~^z=4mswg;5 Y~SVMRXUյڱRf?s:w ;6H:ºi5-maM&O3;1IKeamZh͛7+##v+c ~u~ca]GnF'ټL~PPPbn voC4R,ӟgg %hq}@#M4IÇ Oy^xMZx ) yOw@HkN˖-Sǎmb]X@n+i͖!++K3gd\$mt$^YfJ\8PRF)77Wא!Cl$i:@@_oG I{$# 8磌ŋ91A (Im7֭>}ߴJq7ޗt^ -[ԩSj*}%]&' -ɓ'ꫯVzzvB#;a 7@GxI{j޼ƌ.LÇWBB7`O"I$/@R @eee@۷>}0,ɒ2$53Xs|cS~rpTYYY} kHc %&k.], @ADADADADADADADADA@lT<%''*Lo^={رc5h %$+CnܸQ3fҥK}vUVVs9G R,_{xˇ3o߾;TTTd}馛]uuuG~iԩ@4bnvmvfϞ /Peeeq}}za I~,誫{UWW뮻}_~YƍSMMMYχ֝waw\ďcxꩧtEƍկ_?۷5@u?1kNׯWzz/wy>}zj3 k(ٺuq_Zvf̘:~ ABQ&r|!%KҥKgԞ={<_X-z !CyFUUz~ ABQIIIjݺW$UXXDٳZ~ ABQƍecW$<(~<RSSvZujjjԧOZQu@4 8m&&&jԩg$ď1h ͟?_{768@g =@`)))5o6m3)ѣƌJ;wҿUTT /KZR{~a=@0o<*狔iFɶ[ˎ;T]]OX@?K.ۈxN pppppppppppppppppPfl߾] ,{ァk۶mڿo5BTӦMӴiӴ|r DB2e|An!Dy'tkΝ[A $***t5' "!駟oaDnΝ:t֭[gDШQ06qD;@ x M6v(PiizmZ4ew"@̴ixf [~-Fٱc&IZ2|n!?$@{[HTɏ#@hȎI# _m(F /6Z3z'\r,r!;w2Z3j=~GY7"I$iI.p_"?pN`y DD?: _  Gÿab7J !Bx@0 Bo cG@`1C[@0G @`0C_u V1 aCX>W ` | `!<S `"<. `#c`?cAC4 ?c p#~@0?:08&_MQ1J h#?/`7;I  q 7a wQ A 1 Hp !#<8/#@1Ul7=S=K.4Z?E_$i@!1!E4?`P_  @Bă10#: "aU,xbFY1 [n|n #'vEH:`xb #vD4Y hi.i&EΖv#O H4IŶ}:Ikh @tZRF#(tXҙzZ ?I3l7q@õ|ۍ1,GpuY Ꮿ@hJv#xxk$ v#9 5 }_$c S#=+"K{F*m7`#%H:NRSp6I?sIՖ{Ap$I$I:QRv2$Z @UJ*$]<FO4IENDB`