File Manager

X7ROOT File Manager

Current Path: /usr/local/cpanel/scripts

📁 ..
📄 MirrorSearch_pingtest(2.38 KB)
📄 activesync-invite-reply(1.69 KB)
📄 add_dns(2.36 KB)
📄 adddns(2.36 KB)
📄 addpop(6.08 KB)
📄 addsystemuser(3.27 KB)
📄 adduser(92 B)
📄 apachelimits(4.31 KB)
📄 archive_sync_zones(3.02 KB)
📄 auto-adjust-mysql-limits(1.81 KB)
📄 autorepair(1.24 KB)
📄 backups_clean_metadata_for_missing_backups(1.57 KB)
📄 backups_create_metadata(15.75 KB)
📄 backups_list_user_files(4.56 KB)
📄 balance_linked_node_quotas(2.58 KB)
📄 biglogcheck(1.69 KB)
📄 build_bandwidthdb_root_cache_in_background(1.52 KB)
📄 build_cpnat(3.41 KB)
📄 build_mail_sni(3.87 KB)
📄 build_maxemails_config(1.14 KB)
📄 builddovecotconf(6.76 KB)
📄 buildeximconf(7 KB)
📄 buildhttpdconf(2.6 KB)
📄 buildnsdconf(1.01 KB)
📄 buildpureftproot(539 B)
📄 ccs-check(4.91 KB)
📄 check_cpanel_pkgs(10.75 KB)
📄 check_cpanel_rpms(218 B)
📄 check_domain_tls_service_domains.pl(6.68 KB)
📄 check_immutable_files(5.49 KB)
📄 check_mail_spamassassin_compiledregexps_body_0(187 B)
📄 check_maxmem_against_domains_count(3.57 KB)
📄 check_mount_procfs(2.02 KB)
📄 check_mysql(5.55 KB)
📄 check_security_advice_changes(8.28 KB)
📄 check_unmonitored_enabled_services(4.56 KB)
📄 check_unreliable_resolvers(3.59 KB)
📄 check_users_my_cnf(6.05 KB)
📄 check_valid_server_hostname(7.66 KB)
📄 checkalldomainsmxs(2.4 KB)
📄 checkbashshell(1.18 KB)
📄 checkccompiler(1.22 KB)
📄 checkexim.pl(3.1 KB)
📄 checklink(1.29 KB)
📄 checknsddirs(1014 B)
📄 checkusers(856 B)
📄 chkmydns(561 B)
📄 chkpaths(141 B)
📄 chpass(416 B)
📄 ckillall(1.11 KB)
📄 clean_dead_mailman_locks(2.09 KB)
📄 clean_up_temp_wheel_users(2.44 KB)
📄 clean_user_php_sessions(4.76 KB)
📄 cleandns(13.09 KB)
📄 cleandns8(417 B)
📄 cleanmsglog(735 B)
📄 cleanphpsessions(932 B)
📄 cleanphpsessions.php(658 B)
📄 cleanquotas(1.61 KB)
📄 cleansessions(5.91 KB)
📄 cleanupinterchange(2.64 KB)
📄 cleanupmysqlprivs(533 B)
📄 clear_cpaddon_ui_caches(1.27 KB)
📄 clear_orphaned_virtfs_mounts(3.56 KB)
📄 comparecdb(1.52 KB)
📄 compilers(2.86 KB)
📄 compilerscheck(999 B)
📄 configure_firewall_for_cpanel(520 B)
📄 configure_rh_firewall_for_cpanel(520 B)
📄 configure_rh_ipv6_firewall_for_cpanel(520 B)
📄 convert2dovecot(682 B)
📄 convert_accesshash_to_token(4.07 KB)
📄 convert_and_migrate_from_legacy_backup(1.97 KB)
📄 convert_maildir_to_mdbox(1.66 KB)
📄 convert_mdbox_to_maildir(1.66 KB)
📄 convert_roundcube_mysql2sqlite(25.28 KB)
📄 convert_to_dovecot_delivery(4.33 KB)
📄 convert_whmxfer_to_sqlite(1.46 KB)
📄 copy_user_mail_as_root(1.25 KB)
📄 copy_user_mail_as_user(1.34 KB)
📄 cpaddonsup(3.25 KB)
📄 cpan_config(2.8 KB)
📁 cpan_sandbox
📄 cpanel_initial_install(67.36 KB)
📄 cpanelsync(28.31 KB)
📄 cpanelsync_postprocessor(1.62 KB)
📄 cpanpingtest(965 B)
📄 cpbackup(44.77 KB)
📄 cpbackup_transport_file(5.65 KB)
📄 cpdig(1.81 KB)
📄 cpfetch(1.23 KB)
📄 cphulkdblacklist(433 B)
📄 cphulkdwhitelist(1.3 KB)
📄 cpservice(2.87 KB)
📄 cpuser_port_authority(19.29 KB)
📄 cpuser_service_manager(10.85 KB)
📄 createacct(24.57 MB)
📄 custom_backup_destination.pl.sample(5.06 KB)
📄 custom_backup_destination.pl.skeleton(2.84 KB)
📄 dav_change_hostname(3.57 KB)
📄 dcpumon-wrapper(850 B)
📄 delpop(6.2 KB)
📄 detect_env_capabilities(508 B)
📄 disable_prelink(2.77 KB)
📄 disable_sqloptimizer(1.49 KB)
📄 disablefileprotect(2.09 KB)
📄 distro_changed_hook(1.16 KB)
📄 dnscluster(4.44 KB)
📄 dnsqueuecron(1.29 KB)
📄 dnssec-cluster-keys(3.75 KB)
📄 dovecot_maintenance(7.93 KB)
📄 dovecot_set_defaults.pl(984 B)
📄 dumpcdb(866 B)
📄 dumpinodes(687 B)
📄 dumpquotas(616 B)
📄 dumpstor(913 B)
📄 ea4_fresh_install(2.64 KB)
📄 edit_cpanelsync_exclude_list(2.58 KB)
📄 editquota(3.44 KB)
📄 elevate-cpanel(377.87 KB)
📄 email_archive_maintenance(6.15 KB)
📄 email_hold_maintenance(1.46 KB)
📄 enable_spf_dkim_globally(8.83 KB)
📄 enable_sqloptimizer(1.57 KB)
📄 enablefileprotect(2.1 KB)
📄 ensure_autoenabled_features(2.5 MB)
📄 ensure_conf_dir_crt_key(4.82 KB)
📄 ensure_cpuser_file_ip(2.55 KB)
📄 ensure_crontab_permissions(1.08 KB)
📄 ensure_dovecot_memory_limits_meet_minimum(3.13 KB)
📄 ensure_hostname_resolves(2.57 KB)
📄 ensure_includes(601 B)
📄 ensure_vhost_includes(13.53 KB)
📄 exim_tidydb(2.96 KB)
📄 eximconfgen(1.32 KB)
📄 eximstats_spam_check(867 B)
📄 export_horde_calendars_to_ics(15.07 KB)
📄 export_horde_contacts_to_vcf(13.94 KB)
📄 exportmydnsdb(3.47 KB)
📄 expunge_expired_certificates_from_sslstorage(3.56 KB)
📄 expunge_expired_pkgacct_sessions(852 B)
📄 expunge_expired_transfer_sessions(1.06 KB)
📄 fastmail(5.16 KB)
📄 featuremod(1.92 KB)
📄 fetchfile(422 B)
📄 find_and_fix_rpm_issues(6.99 KB)
📄 find_outdated_services(5.41 KB)
📄 find_pids_with_inotify_watch_on_path(3.66 KB)
📄 fix-cpanel-perl(28.82 KB)
📄 fix-listen-on-localhost(3.52 KB)
📄 fix-web-vhost-configuration(6.15 KB)
📄 fix_addon_permissions(7.68 KB)
📄 fix_dns_zone_ttls(1.34 KB)
📄 fix_innodb_tables(4.05 KB)
📄 fix_pear_registry(4.07 KB)
📄 fix_reseller_acls(10.88 KB)
📄 fixetchosts(4.32 KB)
📄 fixheaders(572 B)
📄 fixmailinglistperms(1008 B)
📄 fixmailman(2.09 KB)
📄 fixnamedviews(1.22 KB)
📄 fixndc(413 B)
📄 fixquotas(17.45 KB)
📄 fixrelayd(1.74 KB)
📄 fixrndc(16.48 KB)
📄 fixtar(503 B)
📄 fixtlsversions(4.7 KB)
📄 fixvaliases(2 KB)
📄 fixwebalizer(966 B)
📄 forcelocaldomain(895 B)
📄 ftpfetch(2.2 KB)
📄 ftpquotacheck(8.31 KB)
📄 ftpsfetch(2.36 KB)
📄 ftpupdate(261 B)
📄 gather_update_log_stats(4.25 KB)
📄 gather_update_logs_setupcrontab(5.45 KB)
📄 gemwrapper(1.74 KB)
📄 gencrt(6.26 KB)
📄 generate_account_suspension_include(5.7 KB)
📄 generate_google_drive_credentials(1.11 KB)
📄 generate_google_drive_oauth_uri(984 B)
📄 generate_maildirsize(13.94 KB)
📄 gensysinfo(1.16 KB)
📄 get_locale_from_legacy_name_info(1.99 KB)
📄 getremotecpmove(12.67 KB)
📄 grpck(1.19 KB)
📄 hackcheck(3.02 KB)
📄 hook(1.45 KB)
📄 httpspamdetect(2.66 KB)
📄 hulk-unban-ip(3.93 MB)
📄 import_exim_data(8.39 KB)
📄 importmydnsdb(11.34 KB)
📄 increase_filesystem_limits(891 B)
📄 initacls(4.99 KB)
📄 initfpsuexec(444 B)
📄 initquotas(19.47 KB)
📄 initsuexec(4.03 KB)
📄 install_cpanel_analytics(1.93 KB)
📄 install_dovecot_fts(1.57 KB)
📄 install_plugin(2.8 KB)
📄 installpkg(575 B)
📄 installpostgres(6.56 KB)
📄 installsqlite3(1.82 KB)
📄 ipcheck(3.93 KB)
📄 ipusage(7.45 KB)
📄 isdedicatedip(602 B)
📄 jetbackup-check(3.69 KB)
📄 killdns(422 B)
📄 killdns-dnsadmin(1.15 KB)
📄 killmysqluserprivs(433 B)
📄 killmysqlwildcard(1.15 KB)
📄 killpvhost(853 B)
📄 killspamkeys(937 B)
📄 link_3rdparty_binaries(1.24 KB)
📄 linksubemailtomainacct(3.17 KB)
📄 listcheck(538 B)
📄 listsubdomains(1.05 KB)
📄 litespeed-check(3.86 KB)
📄 locale_export(4.82 KB)
📄 locale_import(4.35 KB)
📄 locale_info(3.99 KB)
📄 logo.dat(205 B)
📄 magicloader(1.94 KB)
📄 maildir_converter(6.08 KB)
📄 mailperm(16.58 KB)
📄 mailscannerupdate(2.42 KB)
📄 mainipcheck(10 KB)
📄 maintenance(46.62 KB)
📄 make_config(407 B)
📄 make_hostname_unowned(1.16 KB)
📄 manage_extra_marketing(12.41 KB)
📄 manage_greylisting(16.19 KB)
📄 manage_mysql_profiles(20.02 KB)
📄 migrate-pdns-conf(9.83 KB)
📄 migrate_local_ini_to_php_ini(7.41 KB)
📄 migrate_whmtheme_file_to_userdata(2.95 KB)
📄 mkwwwacctconf(2.33 KB)
📄 modify_accounts(4.09 KB)
📄 modify_featurelist(9.2 KB)
📄 modify_packages(3.65 KB)
📄 modsec_vendor(15.63 KB)
📄 mysqlconnectioncheck(6.55 KB)
📄 mysqlpasswd(4.09 KB)
📄 named.ca(1.57 KB)
📄 named.rfc1912.zones(774 B)
📄 nixstatsagent.sh(58.67 KB)
📄 notify_expiring_certificates(9.37 KB)
📄 notify_expiring_certificates_on_linked_nodes(1.33 KB)
📄 oopscheck(1.12 KB)
📄 optimize_eximstats(3.88 KB)
📄 patch_mail_spamassassin_compiledregexps_body_0(2.39 KB)
📄 patchfdsetsize(2.72 KB)
📄 pedquota(2.26 KB)
📄 perform_sqlite_auto_rebuild_db_maintenance(2.2 KB)
📄 perlinstaller(528 B)
📄 perlmods(1.18 KB)
📄 php_fpm_config(9.73 KB)
📁 php_sandbox
📄 phpini_tidy(687 B)
📄 pkgacct(87.82 KB)
📄 post_snapshot(3.16 KB)
📄 post_sync_cleanup(6.09 KB)
📄 primary_virtual_host_migration(2.44 KB)
📄 process_pending_cpanel_php_pear_registration(3.49 KB)
📄 process_site_templates(7.27 KB)
📄 proxydomains(9.34 KB)
📄 ptycheck(724 B)
📄 purge_modsec_log(1.53 KB)
📄 purge_old_config_caches(2.08 KB)
📄 pwck(708 B)
📄 quickdnslookup(1.13 KB)
📄 quickwhoisips(2.29 KB)
📄 quota_auto_fix(1.41 KB)
📄 quotacheck(22.36 KB)
📄 rawchpass(460 B)
📄 rdate(4.8 KB)
📄 realadduser(5.61 KB)
📄 realchpass(3.26 KB)
📄 realperlinstaller(5.67 KB)
📄 realrawchpass(425 B)
📄 rebuild_available_addons_packages_cache(1.27 KB)
📄 rebuild_available_rpm_addons_cache(1.27 KB)
📄 rebuild_bandwidthdb_root_cache(1.45 KB)
📄 rebuild_dbmap(5.8 KB)
📄 rebuild_provider_openid_connect_links_db(1.01 KB)
📄 rebuild_whm_chrome(2.22 KB)
📄 rebuilddnsconfig(26.21 KB)
📄 rebuildhttpdconf(2.6 KB)
📄 rebuildinstalledssldb(2.85 KB)
📄 rebuildippool(509 B)
📄 rebuildnsdzones(1.14 KB)
📄 rebuilduserssldb(948 B)
📄 refresh-dkim-validity-cache(5.97 KB)
📄 regenerate_tokens(2.18 KB)
📄 reloadnsd(821 B)
📄 remote_log_transfer(11.6 KB)
📄 remove_dovecot_index_files(5.89 KB)
📄 removeacct(20.91 MB)
📄 rescan_user_dovecot_fts(2.98 KB)
📄 reset_mail_quotas_to_sane_values(6.82 KB)
📄 resetmailmanurls(2.03 KB)
📄 resetquotas(4.68 KB)
📄 restartsrv(3.23 KB)
📄 restartsrv_apache(422 B)
📄 restartsrv_apache_php_fpm(9.9 MB)
📄 restartsrv_base(9.9 MB)
📄 restartsrv_bind(9.9 MB)
📄 restartsrv_chkservd(427 B)
📄 restartsrv_clamd(9.9 MB)
📄 restartsrv_cpanalyticsd(9.9 MB)
📄 restartsrv_cpanel_php_fpm(9.9 MB)
📄 restartsrv_cpanellogd(9.9 MB)
📄 restartsrv_cpdavd(9.9 MB)
📄 restartsrv_cpgreylistd(9.9 MB)
📄 restartsrv_cphulkd(9.9 MB)
📄 restartsrv_cpipv6(9.9 MB)
📄 restartsrv_cpsrvd(9.9 MB)
📄 restartsrv_crond(9.9 MB)
📄 restartsrv_dnsadmin(9.9 MB)
📄 restartsrv_dovecot(9.9 MB)
📄 restartsrv_exim(9.9 MB)
📄 restartsrv_eximstats(504 B)
📄 restartsrv_ftpd(426 B)
📄 restartsrv_ftpserver(911 B)
📄 restartsrv_httpd(9.9 MB)
📄 restartsrv_imap(437 B)
📄 restartsrv_inetd(2.47 KB)
📄 restartsrv_ipaliases(9.9 MB)
📄 restartsrv_lmtp(437 B)
📄 restartsrv_mailman(9.9 MB)
📄 restartsrv_mydns(9.9 MB)
📄 restartsrv_mysql(9.9 MB)
📄 restartsrv_named(777 B)
📄 restartsrv_nscd(9.9 MB)
📄 restartsrv_nsd(9.9 MB)
📄 restartsrv_p0f(9.9 MB)
📄 restartsrv_pdns(9.9 MB)
📄 restartsrv_pop3(437 B)
📄 restartsrv_postgres(427 B)
📄 restartsrv_postgresql(9.9 MB)
📄 restartsrv_powerdns(442 B)
📄 restartsrv_proftpd(9.9 MB)
📄 restartsrv_pureftpd(9.9 MB)
📄 restartsrv_queueprocd(9.9 MB)
📄 restartsrv_rsyslog(9.9 MB)
📄 restartsrv_rsyslogd(437 B)
📄 restartsrv_spamd(9.9 MB)
📄 restartsrv_sshd(9.9 MB)
📄 restartsrv_syslogd(2.4 KB)
📄 restartsrv_tailwatchd(9.9 MB)
📄 restartsrv_unknown(9.9 MB)
📄 restartsrv_xinetd(422 B)
📄 restorecpuserfromcache(1.96 KB)
📄 restorepkg(36.49 MB)
📄 rfc1912_zones.tar(10 KB)
📄 rpmup(4.77 KB)
📄 rsync-user-homedir.pl(5.76 KB)
📄 run_if_exists(512 B)
📄 run_plugin_lifecycle(3.53 KB)
📄 runstatsonce(440 B)
📄 runweblogs(1.02 KB)
📄 sa-update_wrapper(3.34 KB)
📄 safetybits.pl(844 B)
📄 secureit(4.72 KB)
📄 securemysql(4.54 KB)
📄 securerailsapps(3.58 KB)
📄 securetmp(15.99 KB)
📄 sendicq(474 B)
📄 servicedomains(9.34 KB)
📄 set_mailman_archive_perms(1.75 KB)
📄 set_php_memory_limits(3.67 KB)
📄 setpostgresconfig(6.04 KB)
📄 setup_greylist_db(16.19 KB)
📄 setup_modsec_db(1.3 KB)
📄 setup_systemd_timer_for_plugins(3.92 KB)
📄 setupftpserver(10.47 KB)
📄 setupmailserver(9.55 KB)
📄 setupnameserver(13.75 KB)
📄 shrink_modsec_ip_database(12.97 KB)
📄 simpleps(3.05 KB)
📄 slurp_exim_mainlog(5.78 KB)
📄 smartcheck(15.13 KB)
📄 smtpmailgidonly(8.15 KB)
📄 snapshot_prep(5.88 KB)
📄 spamassassin_dbm_cleaner(5.85 KB)
📄 spamassassindisable(3.74 KB)
📄 spamboxdisable(2.27 KB)
📄 sshcontrol(14.38 KB)
📄 ssl_crt_status(3.84 KB)
📄 suspendacct(18.01 KB)
📄 suspendmysqlusers(4.42 KB)
📄 swapip(3.82 KB)
📄 sync-mysql-users-from-grants(1.2 KB)
📄 sync_child_accounts(1.77 KB)
📄 sync_contact_emails_to_cpanel_users_files(1.14 KB)
📄 synccpaddonswithsqlhost(6.59 KB)
📄 synctransfers(1.92 KB)
📄 syslog_check(1.36 KB)
📄 sysup(645 B)
📄 test_sa_compiled(1.07 KB)
📄 transfer_account_as_user(2.34 KB)
📄 transfer_accounts_as_root(4.76 KB)
📄 transfer_in_progress(3.08 KB)
📄 transfer_in_progress.pod(312 B)
📄 transfermysqlusers(9.53 MB)
📄 try-later(7.95 KB)
📄 unblockip(667 B)
📄 uninstall_cpanel_analytics(1.2 KB)
📄 uninstall_dovecot_fts(562 B)
📄 uninstall_plugin(2.84 KB)
📄 unlink_service_account(2.62 KB)
📄 unpkgacct(4.6 KB)
📄 unslavenamedconf(863 B)
📄 unsuspendacct(17.8 KB)
📄 unsuspendmysqlusers(6.71 KB)
📄 upcp(31.56 KB)
📄 upcp-running(2.7 KB)
📄 upcp.static(708.6 KB)
📄 update-packages(4.77 KB)
📄 update_apachectl(480 B)
📄 update_db_cache(430 B)
📄 update_dkim_keys(1.45 KB)
📄 update_exim_rejects(1.21 KB)
📄 update_existing_mail_quotas_for_account(4.78 KB)
📄 update_known_proxy_ips(1002 B)
📄 update_local_rpm_versions(4.56 KB)
📄 update_mailman_cache(8.34 KB)
📄 update_mysql_systemd_config(1.25 KB)
📄 update_neighbor_netblocks(487 B)
📄 update_sa_config(2.14 KB)
📄 update_spamassassin_config(10.73 KB)
📄 update_users_jail(691 B)
📄 update_users_vhosts(801 B)
📄 updatedomainips(605 B)
📄 updatenameserverips(1.66 KB)
📄 updatenow(5.18 KB)
📄 updatenow.static(1.91 MB)
📄 updatesigningkey(1.95 KB)
📄 updatessldomains(1.81 KB)
📄 updatesupportauthorizations(2.49 KB)
📄 updateuserdatacache(2.47 KB)
📄 updateuserdomains(774 B)
📄 upgrade_bandwidth_dbs(2.22 KB)
📄 upgrade_subaccount_databases(2.73 KB)
📄 userdata_wildcard_cleanup(5.74 KB)
📄 userdirctl(5.01 KB)
📄 validate_sshkey_passphrase(1.21 KB)
📄 verify_api_spec_files(757 B)
📄 verify_pidfile(1.96 KB)
📄 verify_vhost_includes(7.34 KB)
📄 vps_optimizer(7.82 KB)
📄 vzzo-fixer(725 B)
📄 whmlogin(2.33 KB)
📄 whoowns(1.13 KB)
📄 wpt_license(6.27 MB)
📄 wwwacct(24.57 MB)
📄 wwwacct2(88 B)
📄 xfer_rcube_schema_migrate.pl(2.4 KB)
📄 xfer_rcube_uid_resolver.pl(1.8 KB)
📄 xferpoint(3.13 KB)
📄 xfertool(16.14 KB)
📄 zoneexists(800 B)

Editing: backups_create_metadata

#!/usr/local/cpanel/3rdparty/bin/perl

# cpanel - scripts/backups_create_metadata         Copyright 2022 cPanel, L.L.C.
#                                                           All rights reserved.
# copyright@cpanel.net                                         http://cpanel.net
# This code is subject to the cPanel license. Unauthorized copying is prohibited

################################################################################

package scripts::backups_create_metadata;

use strict;
use warnings;

use Cpanel::Backup::Config         ();
use Cpanel::Backup::Metadata       ();
use Cpanel::Backup::StreamFileList ();
use Cpanel::Config::LoadCpConf     ();
use Cpanel::ConfigFiles            ();
use Cpanel::FileUtils::Path        ();
use Cpanel::IONice                 ();
use Cpanel::Logger                 ();
use Cpanel::OSSys                  ();
use Cpanel::OSSys::Capabilities    ();
use Cpanel::SafeRun::Simple        ();

use Getopt::Long ();
use File::Glob   ();
use File::Spec   ();

use Try::Tiny;

################################################################################

our $all;
our $backup;
our $user;
our $vacuum;
our $schedule_rebuild;
our $fix_corrupt;

our $logger;

sub _help {
    my ($msg) = @_;

print qq{$msg

Usage:

--all - Create metadata for all backups in the configured directory.

e.g. $0 --all
This creates metadata for all backups and users.
If metadata exists, it will delete it and create new metadata.
You cannot combine --all with other options.

--vacuum - Defragment the database and release unused space, runs in the background

e.g. $0 --vacuum
This defragments the database and release unused space.
You cannot combine --vacuum with other options.

--backup=monthly/YYYY-MM-DD - Create metadata for all users in the backup directory that you specify.

e.g. $0 --backup=monthly/2017-03-01
This creates metadata for all users in this backup directory.
You can combine this option with the --user option.
e.g. $0 --backup=monthly/2017-03-01 --user=alvin
This creates metadata for this user in this backup directory.

--user=user - Create metadata only for this user.

e.g. $0 --user=alvin
This creates metadata only for this user.
You can combine this option with the --backup=monthly/YYYY-MM-DD option.
e.g. $0 --backup=monthly/2017-03-01 --user=alvin
This creates metadata for this user in this backup directory.

--schedule_rebuild - Rebuild all metadata in the background.

e.g. $0 --schedule_rebuild
This rebuilds all metadata. The script returns to the command line immediately and
continues to rebuild the metadata in a background task.
You can combine this option with the --fix_corrupt option.
e.g. $0 --schedule_rebuild --fix_corrupt
This scans all user metadata and rebuilds corrupt metadata. The script returns to
the command line immediately and continues to rebuild the metadata in a background
task.

--fix_corrupt - Scans all user metadata to identify and rebuild corrupt metadata.
e.g. $0 --fix_corrupt
This scans all user metadata and rebuilds corrupt metadata.
You can combine this option with the --schedule_rebuild option.
e.g. $0 --schedule_rebuild --fix_corrupt
This scans all user metadata and rebuilds corrupt metadata. The script returns to
the command line immediately and continues to rebuild the metadata in a background
task.
};

exit 0;
}

sub _invalid_parms {
    _help("invalid parameters");
    die "Invalid Command Line Parameters\n";
}

sub _output {
    my ($line) = @_;

print $line . "\n";

return;
}

sub clean_old_metadata_files {
    my ($dir) = @_;

opendir( my $accounts_dir, "$dir/accounts/" );
    foreach my $file ( readdir($accounts_dir) ) {
        if ( ( $file =~ m/\-\=\-meta/ || $file eq '.sql_dump.gz' ) && -f "$dir/accounts/$file" ) {
            print "Removing old metadata file $dir/accounts/$file\n";
            unlink("$dir/accounts/$file");
        }
    }
    closedir($accounts_dir);

# Clean old version of single sqlitedb
    unlink '/var/cpanel/backups/metadata.sqlite';

return;
}

sub create_master_meta {
    my ($dir) = @_;

my $meta_master = $dir . "/accounts/.master.meta";
    if ( !-e $meta_master ) {
        my $ref = Cpanel::Backup::Metadata::introspect_old_backup($dir);
        if ( defined( $ref->{'backup'}->{'backup_type'} ) && $ref->{'backup'}->{'backup_type'} ne 'ERROR' ) {
            Cpanel::Backup::Metadata::create_meta_master_with_users_from_introspect( $dir, $ref );
        }
        else {
            return 0;    # ignore if the directory cannot be determined
        }
    }

return 1;
}

# Set our "nice" level

sub apply_nice_level_to_process {
    my ($logger) = @_;
    my $cpconf_ref;
    ( %{$cpconf_ref} ) = Cpanel::Config::LoadCpConf::loadcpconf();

Cpanel::OSSys::nice(18);    # needs to be one higher for cpuwatch
    my $CAPABILITIES = Cpanel::OSSys::Capabilities->load;
    if ( $CAPABILITIES->capable_of('ionice') ) {
        if ( Cpanel::IONice::ionice( 'best-effort', exists $cpconf_ref->{'ionice_cpbackup'} ? $cpconf_ref->{'ionice_cpbackup'} : 6 ) ) {
            $logger->info( "Setting I/O priority to reduce system load: " . Cpanel::IONice::get_ionice() );
        }
    }
    return;
}

sub _run_vacuum {
    require Cpanel::Daemonizer::Tiny;

Cpanel::Daemonizer::Tiny::run_as_daemon(
        sub {
            require Cpanel::Logger;
            my $logger = Cpanel::Logger->new();
            sleep 15;
            Cpanel::Backup::Metadata::vacuum_metadata($logger);
        },
        ""
    );

return;
}

sub _get_raw_backup_dirs {
    my ($backup_master_dir) = @_;

# get all backup dirs under the main backup
    my %backup_dirs_hash;

foreach my $dir (
        File::Glob::bsd_glob( $backup_master_dir . "/2*/accounts" ),
        File::Glob::bsd_glob( $backup_master_dir . "/monthly/2*/accounts" ),
        File::Glob::bsd_glob( $backup_master_dir . "/weekly/2*/accounts" ),
        File::Glob::bsd_glob( $backup_master_dir . "/incremental/accounts" )
    ) {
        next if ( !-d $dir );
        my ( $xdir, $accounts ) = Cpanel::FileUtils::Path::dir_and_file_from_path($dir);
        $backup_dirs_hash{$xdir} = 1;
    }

return %backup_dirs_hash;
}

sub _get_all_backup_dirs {
    my ( $backup_master_dir, %backup_dirs_hash ) = @_;

# sort this in a smart manner so it plays out like it would have had
    # bin/backup done it.

my @order;
    foreach my $dir ( sort keys %backup_dirs_hash ) {
        my $introspect_ref;
        try {
            $introspect_ref = Cpanel::Backup::Metadata::introspect_old_backup($dir);
        };
        next if !$introspect_ref;                                        # if it dies this is not a valid backup dir, so just move on
        next if !exists $introspect_ref->{'backup'}->{'backup_id'};
        next if $introspect_ref->{'backup'}->{'backup_id'} eq 'ERROR';

my @users = keys %{ $introspect_ref->{'users'} };
        next if !@users;
        my $user = $users[0];

my $category_ref = Cpanel::Backup::StreamFileList::categorize_backup( $backup_master_dir, $dir, $user );

my $sort_path = $category_ref->{'backupID'};
        if ( $sort_path =~ m{^(monthly|weekly)/(.*)$} ) {
            $sort_path = $2 . '/' . $1;
        }
        else {
            $sort_path .= '/a';    # for sorting consistency a is before (m)onthly
        }

$category_ref->{'sort_path'} = $sort_path;
        push( @order, $category_ref );
    }

my @dirs = map { $_->{'path'} } sort { $a->{'sort_path'} cmp $b->{'sort_path'} } @order;

return @dirs;
}

sub fix_corrupt_metadata {
    my ( $backup_master_dir, @users ) = @_;

# delete the users db's
    foreach my $user (@users) {
        my $user_db_path = Cpanel::Backup::Metadata::get_metadata_filename( $user, 0 );
        unlink $user_db_path if -f $user_db_path;
    }

my @dirs = _get_all_backup_dirs( $backup_master_dir, _get_raw_backup_dirs($backup_master_dir) );
    foreach my $user (@users) {
        print "Fixing corrupt backup metadata for $user\n";
        foreach my $dir (@dirs) {
            Cpanel::Backup::Metadata::create_metadata_for_backup_user( $dir, $user, $logger );
        }
    }

return;
}

sub script {    ##no critic qw(ProhibitExcessComplexity)
    my (@args) = @_;

$ENV{'LANG'} = 'en_US.UTF-8';

local $| = 1;
    $logger //= Cpanel::Logger->new( { 'alternate_logfile' => '/dev/stdout' } );

apply_nice_level_to_process($logger);

my $opts = Getopt::Long::GetOptionsFromArray(
        \@args,
        'all'              => \$all,
        'backup=s'         => \$backup,
        'user=s'           => \$user,
        'vacuum'           => \$vacuum,
        'schedule_rebuild' => \$schedule_rebuild,
        'fix_corrupt'      => \$fix_corrupt,
    ) or _invalid_parms();

_help("You must provide at least one option to execute the script.") if ( !$all && !$backup && !$vacuum && !$schedule_rebuild && !$user && !$fix_corrupt );

_help("You cannot combine --all with other options.") if ( $all && ( $backup || $user || $vacuum || $schedule_rebuild || $fix_corrupt ) );

_help("You cannot combine --vacuum with other options.") if ( $vacuum && ( $all || $backup || $user || $schedule_rebuild || $fix_corrupt ) );

_help("You can only combine this option with the --user option.")   if ( $backup && ( $all || $schedule_rebuild || $fix_corrupt || $vacuum ) );
    _help("You can only combine this option with the --backup option.") if ( $user   && ( $all || $schedule_rebuild || $fix_corrupt || $vacuum ) );

_help("You can only combine this option with the --fix_corrupt option.")      if ( $schedule_rebuild && ( $all || $backup || $user || $vacuum ) );
    _help("You can only combine this option with the --schedule_rebuild option.") if ( $fix_corrupt      && ( $all || $backup || $user || $vacuum ) );

my $conf              = Cpanel::Backup::Config::load();
    my $backup_master_dir = $conf->{'BACKUPDIR'};

# if --user is on the command line by itself, leverage the --all code to
    # process all the backups but for this user only.

if ( $user && !$backup ) {
        $all = $backup_master_dir;
    }

# if disabled do not do anything, unless it is all then allow the
    # cleanup operation to happen, but then fail

Cpanel::Backup::Metadata::metadata_disabled_check(1) if ( !$all );

#We use this two places, may as well just get it now
    my @users;

if ($user) {
        push( @users, $user );
    }
    else {
        @users = Cpanel::Backup::Metadata::get_all_users();
    }

if ($all) {
        $all = $backup_master_dir;

foreach my $this_user (@users) {
            my $db = Cpanel::Backup::Metadata::get_metadata_filename($this_user);
            unlink $db if -f $db;
        }

my %backup_dirs_hash = _get_raw_backup_dirs($backup_master_dir);

# clean old metadata
        foreach my $dir ( sort keys %backup_dirs_hash ) {
            try {
                clean_old_metadata_files($dir);

# delete existing master meta, as it may be of an older type
                my $meta_master = $dir . "/accounts/.master.meta";
                unlink $meta_master if -e $meta_master;
            }
            catch {
                $logger->warn("Failed to clean old metadata for $dir :$_:");
            };
        }

# allow the clean up to take place regardless of disabled or not
        # but then fail if metadata is disabled
        Cpanel::Backup::Metadata::metadata_disabled_check(1);

my @dirs = _get_all_backup_dirs( $backup_master_dir, %backup_dirs_hash );
        foreach my $dir (@dirs) {
            print "Processing directory “$dir”\n";
            my $ret;

try {
                $ret = create_master_meta($dir);
            }
            catch {
                $logger->warn("Failed to create metadata for $dir :$_:");
            };

next if !$ret;    # ignore if the directory cannot be determined

try {
                if ($user) {
                    Cpanel::Backup::Metadata::create_metadata_for_backup_user( $dir, $user, $logger );
                }
                else {
                    Cpanel::Backup::Metadata::create_metadata_for_backup( $dir, $logger );
                }
            }
            catch {
                $logger->warn("Failed to create metadata for $dir : $! ($_)");
            };
        }

_run_vacuum();
    }
    elsif ($backup) {
        $backup = $backup_master_dir . "/$backup";

my $backup_ref = Cpanel::Backup::StreamFileList::categorize_backup( $backup_master_dir, $backup, "dontcare" );
        if ( $backup_ref->{'backupID'} eq "ERROR" ) {
            _help("backup parameter is not a valid backup");
        }

if ($user) {
            $backup_ref = Cpanel::Backup::StreamFileList::categorize_backup( $backup_master_dir, $backup, $user );
            if ( $backup_ref->{'type'} eq 'unknown' ) {
                _help("user parameter is not a valid backup");
            }

try {
                if ( !create_master_meta($backup) ) {
                    die "Cannot create backup";    # is caught and warned
                }
                my $master_meta = Cpanel::Backup::Metadata::load_master_meta($backup);
                foreach my $user_ref ( values %{ $master_meta->{'users'} } ) {

next if ( $user_ref->{'user'} ne $user );
                    $logger->info("Processing Backup $backup for User $user");
                    Cpanel::Backup::Metadata::create_metadata_for_backup_user( $backup, $user_ref->{'user'}, $logger );
                    last;
                }
            }
            catch {
                $logger->warn("Failed to create metadata for $backup");
            }
        }
        else {
            try {
                if ( !create_master_meta($backup) ) {
                    die "Cannot create backup";    # is caught and warned
                }

$logger->info("Processing Backup $backup");
                Cpanel::Backup::Metadata::create_metadata_for_backup( $backup, $logger );
            }
            catch {
                $logger->warn("Failed to create metadata for $backup");
            }
        }

_run_vacuum();
        $logger->info("Processing is complete.");
    }
    elsif ($vacuum) {
        _run_vacuum();
    }
    elsif ($schedule_rebuild) {
        if ($fix_corrupt) {
            print "Fixing corrupted backup metadata in the background\n";
        }
        else {
            print "Creating all backup metadata in the background\n";
        }

# remove old metadata, and regen with new schema
        require Cpanel::Daemonizer::Tiny;

Cpanel::Daemonizer::Tiny::run_as_daemon(
            sub {
                # Don't lose output from the script when it detaches from here and goes off on it's own
                open( STDERR, '>>', $Cpanel::ConfigFiles::CPANEL_ROOT . '/logs/error_log' ) or warn "Could not open cPanel Error Log: $!";
                open( STDOUT, '>>', $Cpanel::ConfigFiles::CPANEL_ROOT . '/logs/error_log' ) or warn "Could not open cPanel Error Log: $!";

if ($fix_corrupt) {
                    Cpanel::SafeRun::Simple::saferun( '/usr/local/cpanel/scripts/backups_create_metadata', '--fix_corrupt' );
                }
                else {
                    Cpanel::SafeRun::Simple::saferun( '/usr/local/cpanel/scripts/backups_create_metadata', '--all' );
                }
            },
            ""
        );
    }
    elsif ($fix_corrupt) {
        my ( $dbs_valid, $broken_users_ar ) = Cpanel::Backup::Metadata::is_database_valid( \@users );
        if ($dbs_valid) {
            print "No user metadata is corrupt\n";
        }
        else {
            try {
                fix_corrupt_metadata( $backup_master_dir, keys %{$broken_users_ar} );
            }
            catch {
                print "Error fixing corrupt backup metadata: $_\n";
            };
        }
    }

return 1;
}

exit( script(@ARGV) ? 0 : 1 ) unless caller();

X7ROOT File Manager

Editing: backups_create_metadata

Upload File

Create Folder