FM / scripts

/usr/local/cpanel/scripts

Name	Size	Mode	Actions
cpan_sandbox/	-	0755	rm
php_sandbox/	-	0755	rm
activesync-invite-reply	1734	0755	edit dl rm
adddns	2418	0755	edit dl rm
addpop	6228	0755	edit dl rm
addsystemuser	3345	0755	edit dl rm
adduser	92	0755	edit dl rm
add_dns	2418	0755	edit dl rm
agent360.sh	16410	0700	edit dl rm
apachelimits	4410	0755	edit dl rm
archive_sync_zones	3122	0755	edit dl rm
auto-adjust-mysql-limits	1854	0755	edit dl rm
autorepair	1274	0755	edit dl rm
backups_clean_metadata_for_missing_backups	1612	0755	edit dl rm
backups_create_metadata	16126	0755	edit dl rm
backups_list_user_files	4671	0755	edit dl rm
backup_jobs_helper	11139	0755	edit dl rm
balance_linked_node_quotas	2643	0755	edit dl rm
biglogcheck	1729	0755	edit dl rm
builddovecotconf	9869	0755	edit dl rm
buildeximconf	7167	0755	edit dl rm
buildhttpdconf	2664	0755	edit dl rm
buildpureftproot	539	0755	edit dl rm
build_bandwidthdb_root_cache_in_background	1561	0755	edit dl rm
build_cpnat	3494	0755	edit dl rm
build_mail_sni	3966	0755	edit dl rm
build_maxemails_config	1169	0755	edit dl rm
call_pkgacct	2306	0755	edit dl rm
ccs-check	5031	0755	edit dl rm
checkalldomainsmxs	2462	0755	edit dl rm
checkbashshell	1205	0755	edit dl rm
checkccompiler	1253	0755	edit dl rm
checkexim.pl	3172	0755	edit dl rm
checklink	1323	0755	edit dl rm
checkusers	856	0755	edit dl rm
check_cpanel_pkgs	10856	0755	edit dl rm
check_domain_tls_service_domains.pl	6841	0755	edit dl rm
check_immutable_files	5621	0755	edit dl rm
check_mail_spamassassin_compiledregexps_body_0	187	0755	edit dl rm
check_maxmem_against_domains_count	3652	0755	edit dl rm
check_mount_procfs	2072	0755	edit dl rm
check_mysql	5697	0755	edit dl rm
check_plugin_pkgs	2512	0755	edit dl rm
check_security_advice_changes	8477	0755	edit dl rm
check_unmonitored_enabled_services	4666	0755	edit dl rm
check_unreliable_resolvers	3672	0755	edit dl rm
check_users_my_cnf	6191	0755	edit dl rm
check_valid_server_hostname	7840	0755	edit dl rm
chkpaths	141	0755	edit dl rm
chpass	416	0755	edit dl rm
ckillall	1139	0755	edit dl rm
cleandns	13429	0755	edit dl rm
cleandns8	417	0755	edit dl rm
cleanmsglog	735	0755	edit dl rm
cleanphpsessions	932	0755	edit dl rm
cleanphpsessions.php	658	0644	edit dl rm
cleanquotas	1651	0755	edit dl rm
cleansessions	6032	0755	edit dl rm
cleanupinterchange	2706	0755	edit dl rm
cleanupmysqlprivs	773	0755	edit dl rm
clean_dead_mailman_locks	2141	0755	edit dl rm
clean_up_temp_wheel_users	2498	0755	edit dl rm
clean_user_php_sessions	4875	0755	edit dl rm
clear_orphaned_virtfs_mounts	3645	0755	edit dl rm
comet_license_registration_sync	1711	0755	edit dl rm
comet_protected_item_maintenance	21281	0755	edit dl rm
comparecdb	1561	0755	edit dl rm
compilers	2932	0755	edit dl rm
compilerscheck	999	0755	edit dl rm
configure_firewall_for_cpanel	520	0755	edit dl rm
configure_rh_firewall_for_cpanel	520	0755	edit dl rm
configure_rh_ipv6_firewall_for_cpanel	520	0755	edit dl rm
convert2dovecot	682	0755	edit dl rm
convert_accesshash_to_token	4171	0755	edit dl rm
convert_and_migrate_from_legacy_backup	2017	0755	edit dl rm
convert_maildir_to_mdbox	1703	0755	edit dl rm
convert_mdbox_to_maildir	1698	0755	edit dl rm
convert_roundcube_mysql2sqlite	26748	0755	edit dl rm
convert_to_dovecot_delivery	4438	0755	edit dl rm
convert_whmxfer_to_sqlite	1499	0755	edit dl rm
copy_user_mail_as_root	1281	0755	edit dl rm
copy_user_mail_as_user	1375	0755	edit dl rm
cpanelsync	28991	0755	edit dl rm
cpanelsync_postprocessor	1657	0755	edit dl rm
cpanel_initial_install	69583	0755	edit dl rm
cpanpingtest	965	0755	edit dl rm
cpan_config	2870	0755	edit dl rm
cpbackup	45861	0755	edit dl rm
cpbackup_transport_file	5781	0755	edit dl rm
cpdig	2882	0755	edit dl rm
cpfetch	1258	0755	edit dl rm
cphulkdblacklist	433	0755	edit dl rm
cphulkdwhitelist	1336	0755	edit dl rm
cpservice	2934	0755	edit dl rm
cpuser_port_authority	19755	0755	edit dl rm
cpuser_service_manager	11113	0755	edit dl rm
createacct	31904760	0700	edit dl rm
create_default_featurelist	11903	0700	edit dl rm
custom_backup_destination.pl.sample	5182	0755	edit dl rm
custom_backup_destination.pl.skeleton	2906	0755	edit dl rm
dcpumon-wrapper	850	0755	edit dl rm
delpop	6350	0755	edit dl rm
detect_env_capabilities	508	0755	edit dl rm
disablefileprotect	2241	0755	edit dl rm
disable_prelink	2841	0755	edit dl rm
distro_changed_hook	1185	0755	edit dl rm
dnscluster	4546	0755	edit dl rm
dnsqueuecron	1316	0755	edit dl rm
dnssec-cluster-keys	3840	0755	edit dl rm
dovecot_maintenance	7842	0755	edit dl rm
dovecot_set_defaults.pl	984	0755	edit dl rm
dumpcdb	866	0755	edit dl rm
dumpinodes	687	0755	edit dl rm
dumpquotas	616	0755	edit dl rm
dumpstor	913	0755	edit dl rm
ea4_fresh_install	2699	0755	edit dl rm
editquota	3512	0755	edit dl rm
edit_cpanelsync_exclude_list	2641	0755	edit dl rm
elevate-cpanel	424577	0700	edit dl rm
email_archive_maintenance	6300	0755	edit dl rm
email_hold_maintenance	1495	0755	edit dl rm
enablefileprotect	2149	0755	edit dl rm
enable_spf_dkim_globally	9039	0755	edit dl rm
ensure_autoenabled_features	3322632	0700	edit dl rm
ensure_conf_dir_crt_key	4940	0755	edit dl rm
ensure_cpuser_file_ip	2610	0755	edit dl rm
ensure_crontab_permissions	1101	0755	edit dl rm
ensure_dovecot_memory_limits_meet_minimum	3208	0755	edit dl rm
ensure_hostname_resolves	2572	0755	edit dl rm
ensure_includes	601	0755	edit dl rm
ensure_vhost_includes	13851	0755	edit dl rm
eximconfgen	1350	0755	edit dl rm
eximstats_spam_check	867	0755	edit dl rm
exim_tidydb	3036	0755	edit dl rm
expunge_expired_certificates_from_sslstorage	3648	0755	edit dl rm
expunge_expired_pkgacct_sessions	852	0755	edit dl rm
expunge_expired_transfer_sessions	1089	0755	edit dl rm
fastmail	5281	0755	edit dl rm
featuremod	1970	0755	edit dl rm
fetchfile	422	0755	edit dl rm
find_and_fix_rpm_issues	7157	0755	edit dl rm
find_outdated_services	6625	0755	edit dl rm
find_pids_with_inotify_watch_on_path	3745	0755	edit dl rm
fix-cpanel-perl	29112	0755	edit dl rm
fix-listen-on-localhost	4036	0755	edit dl rm
fix-web-vhost-configuration	6296	0755	edit dl rm
fixetchosts	4424	0755	edit dl rm
fixheaders	572	0755	edit dl rm
fixmailinglistperms	1008	0755	edit dl rm
fixmailman	2144	0755	edit dl rm
fixnamedviews	1247	0755	edit dl rm
fixndc	413	0755	edit dl rm
fixquotas	18834	0755	edit dl rm
fixrelayd	1784	0755	edit dl rm
fixrndc	16780	0755	edit dl rm
fixtar	503	0755	edit dl rm
fixtlsversions	4816	0755	edit dl rm
fixvaliases	2047	0755	edit dl rm
fixwebalizer	966	0755	edit dl rm
fix_dns_zone_ttls	1369	0755	edit dl rm
fix_innodb_tables	4149	0755	edit dl rm
fix_reseller_acls	10958	0755	edit dl rm
forcelocaldomain	895	0755	edit dl rm
ftpfetch	2251	0755	edit dl rm
ftpquotacheck	8511	0755	edit dl rm
ftpsfetch	2416	0755	edit dl rm
ftpupdate	261	0755	edit dl rm
gather_update_logs_setupcrontab	5582	0700	edit dl rm
gather_update_log_stats	4354	0700	edit dl rm
gemwrapper	1783	0755	edit dl rm
gencrt	6410	0755	edit dl rm
generate_account_suspension_include	5840	0755	edit dl rm
generate_google_drive_credentials	1135	0755	edit dl rm
generate_google_drive_oauth_uri	984	0755	edit dl rm
generate_maildirsize	14908	0755	edit dl rm
gensysinfo	1185	0755	edit dl rm
getremotecpmove	23084	0755	edit dl rm
get_locale_from_legacy_name_info	2041	0755	edit dl rm
grpck	1218	0755	edit dl rm
hackcheck	3092	0755	edit dl rm
hook	1487	0755	edit dl rm
httpspamdetect	2891	0755	edit dl rm
hulk-unban-ip	4301456	0700	edit dl rm
import_exim_data	8593	0755	edit dl rm
increase_filesystem_limits	891	0755	edit dl rm
initacls	5107	0755	edit dl rm
initfpsuexec	444	0755	edit dl rm
initialize_360monitoring	2824	0700	edit dl rm
initquotas	19811	0755	edit dl rm
initsuexec	4123	0755	edit dl rm
installpkg	575	0755	edit dl rm
installpostgres	6715	0755	edit dl rm
installsqlite3	1866	0755	edit dl rm
install_cpanel_analytics	1973	0755	edit dl rm
install_dovecot_fts	1605	0755	edit dl rm
install_plugin	2869	0755	edit dl rm
install_tuxcare_els_php	1889	0755	edit dl rm
ipcheck	4020	0755	edit dl rm
ipusage	7624	0755	edit dl rm
isdedicatedip	602	0755	edit dl rm
is_update_available	3343	0755	edit dl rm
jetbackup-check	3776	0755	edit dl rm
killdns	422	0755	edit dl rm
killdns-dnsadmin	1180	0755	edit dl rm
killmysqluserprivs	433	0755	edit dl rm
killmysqlwildcard	1180	0755	edit dl rm
killpvhost	853	0755	edit dl rm
killspamkeys	937	0755	edit dl rm
linksubemailtomainacct	3248	0755	edit dl rm
link_3rdparty_binaries	1271	0755	edit dl rm
listcheck	538	0755	edit dl rm
listsubdomains	1074	0755	edit dl rm
litespeed-check	3952	0755	edit dl rm
locale_export	5331	0755	edit dl rm
locale_import	4803	0755	edit dl rm
locale_info	4086	0755	edit dl rm
logo.dat	205	0644	edit dl rm
log_retention	21793	0755	edit dl rm
magicloader	1985	0755	edit dl rm
maildir_converter	6222	0755	edit dl rm
mailperm	16923	0755	edit dl rm
mailscannerupdate	2478	0755	edit dl rm
mainipcheck	10236	0755	edit dl rm
maintenance	53445	0755	edit dl rm
make_config	407	0644	edit dl rm
make_hostname_unowned	1189	0755	edit dl rm
manage_extra_marketing	13068	0700	edit dl rm
manage_greylisting	16719	0755	edit dl rm
manage_mysql_profiles	16727	0755	edit dl rm
mass_change_php_setting	10904	0755	edit dl rm
migrate_ccs_to_cpdavd	48186	0755	edit dl rm
migrate_local_ini_to_php_ini	7587	0755	edit dl rm
migrate_whmtheme_file_to_userdata	3025	0755	edit dl rm
MirrorSearch_pingtest	2437	0755	edit dl rm
mkwwwacctconf	2385	0755	edit dl rm
modify_accounts	4169	0755	edit dl rm
modify_featurelist	11597	0700	edit dl rm
modify_packages	3726	0755	edit dl rm
modsec_vendor	16008	0755	edit dl rm
mysqlconnectioncheck	6877	0755	edit dl rm
mysqlpasswd	4235	0755	edit dl rm
named.ca	1603	0644	edit dl rm
named.rfc1912.zones	774	0644	edit dl rm
notify_expiring_certificates	9592	0755	edit dl rm
notify_expiring_certificates_on_linked_nodes	1361	0755	edit dl rm
oopscheck	1142	0755	edit dl rm
optimize_eximstats	3975	0755	edit dl rm
panel_ini	4210	0755	edit dl rm
patchfdsetsize	2784	0755	edit dl rm
patch_mail_spamassassin_compiledregexps_body_0	2452	0755	edit dl rm
pedquota	2310	0755	edit dl rm
perform_sqlite_auto_rebuild_db_maintenance	2031	0755	edit dl rm
perlinstaller	528	0755	edit dl rm
perlmods	1204	0755	edit dl rm
phpini_tidy	687	0755	edit dl rm
php_fpm_config	9968	0755	edit dl rm
pkgacct	92065	0755	edit dl rm
post_snapshot	2144	0755	edit dl rm
post_sync_cleanup	5973	0755	edit dl rm
primary_virtual_host_migration	2502	0755	edit dl rm
process_cpmove	4419	0755	edit dl rm
process_pending_cpanel_php_pear_registration	2793	0755	edit dl rm
proxydomains	9822	0755	edit dl rm
ptycheck	724	0755	edit dl rm
purge_modsec_log	1563	0755	edit dl rm
purge_old_config_caches	2125	0755	edit dl rm
pwck	708	0755	edit dl rm
quickdnslookup	1159	0755	edit dl rm
quickwhoisips	2348	0755	edit dl rm
quotacheck	22900	0755	edit dl rm
quota_auto_fix	1440	0755	edit dl rm
rawchpass	460	0755	edit dl rm
rdate	4913	0755	edit dl rm
realadduser	5743	0755	edit dl rm
realchpass	3336	0755	edit dl rm
realperlinstaller	5805	0755	edit dl rm
realrawchpass	425	0755	edit dl rm
rebuilddnsconfig	26110	0755	edit dl rm
rebuildhttpdconf	2664	0755	edit dl rm
rebuildinstalledssldb	2917	0755	edit dl rm
rebuildippool	509	0755	edit dl rm
rebuilduserssldb	948	0755	edit dl rm
rebuild_bandwidthdb_root_cache	1487	0755	edit dl rm
rebuild_dbmap	5937	0755	edit dl rm
rebuild_provider_openid_connect_links_db	1039	0755	edit dl rm
rebuild_whm_chrome	2277	0755	edit dl rm
refresh-dkim-validity-cache	6110	0755	edit dl rm
regenerate_tokens	2228	0755	edit dl rm
remote_log_transfer	11875	0755	edit dl rm
removeacct	29654400	0700	edit dl rm
remove_dovecot_index_files	6028	0755	edit dl rm
rescan_user_dovecot_fts	3048	0755	edit dl rm
resetmailmanurls	2077	0755	edit dl rm
resetquotas	4723	0755	edit dl rm
reset_mail_quotas_to_sane_values	6982	0755	edit dl rm
restartsrv	3266	0755	edit dl rm
restartsrv_apache	422	0755	edit dl rm
restartsrv_apache_php_fpm	11368960	0755	edit dl rm
restartsrv_base	11368960	0755	edit dl rm
restartsrv_bind	11368960	0755	edit dl rm
restartsrv_chkservd	427	0755	edit dl rm
restartsrv_clamd	11368960	0755	edit dl rm
restartsrv_cpanellogd	11368960	0755	edit dl rm
restartsrv_cpanel_php_fpm	11368960	0755	edit dl rm
restartsrv_cpdavd	11368960	0755	edit dl rm
restartsrv_cpgreylistd	11368960	0755	edit dl rm
restartsrv_cphulkd	11368960	0755	edit dl rm
restartsrv_cpipv6	11368960	0755	edit dl rm
restartsrv_cpsrvd	11368960	0755	edit dl rm
restartsrv_crond	11368960	0755	edit dl rm
restartsrv_dnsadmin	11368960	0755	edit dl rm
restartsrv_dovecot	11368960	0755	edit dl rm
restartsrv_exim	11368960	0755	edit dl rm
restartsrv_eximstats	504	0755	edit dl rm
restartsrv_ftpd	426	0755	edit dl rm
restartsrv_ftpserver	911	0755	edit dl rm
restartsrv_httpd	11368960	0755	edit dl rm
restartsrv_imap	437	0755	edit dl rm
restartsrv_inetd	2525	0755	edit dl rm
restartsrv_ipaliases	11368960	0755	edit dl rm
restartsrv_lmtp	437	0755	edit dl rm
restartsrv_mailman	11368960	0755	edit dl rm
restartsrv_mysql	11368960	0755	edit dl rm
restartsrv_named	579	0755	edit dl rm
restartsrv_nscd	11368960	0755	edit dl rm
restartsrv_p0f	11368960	0755	edit dl rm
restartsrv_pdns	11368960	0755	edit dl rm
restartsrv_pop3	437	0755	edit dl rm
restartsrv_postgres	427	0755	edit dl rm
restartsrv_postgresql	11368960	0755	edit dl rm
restartsrv_powerdns	442	0755	edit dl rm
restartsrv_proftpd	11368960	0755	edit dl rm
restartsrv_pureftpd	11368960	0755	edit dl rm
restartsrv_queueprocd	11368960	0755	edit dl rm
restartsrv_rsyslog	11368960	0755	edit dl rm
restartsrv_rsyslogd	437	0755	edit dl rm
restartsrv_spamd	11368960	0755	edit dl rm
restartsrv_sshd	11368960	0755	edit dl rm
restartsrv_syslogd	2458	0755	edit dl rm
restartsrv_tailwatchd	11368960	0755	edit dl rm
restartsrv_unknown	11368960	0755	edit dl rm
restartsrv_xinetd	422	0755	edit dl rm
restorecpuserfromcache	2008	0755	edit dl rm
restorepkg	51194360	0700	edit dl rm
rfc1912_zones.tar	10240	0644	edit dl rm
rpmup	5191	0755	edit dl rm
rsync-user-homedir.pl	5903	0755	edit dl rm
runstatsonce	440	0755	edit dl rm
runweblogs	1045	0755	edit dl rm
run_if_exists	512	0755	edit dl rm
run_plugin_lifecycle	4060	0700	edit dl rm
sa-update_wrapper	3418	0755	edit dl rm
safetybits.pl	844	0755	edit dl rm
secureit	4834	0755	edit dl rm
securemysql	4501	0755	edit dl rm
securerailsapps	3661	0755	edit dl rm
securetmp	17162	0755	edit dl rm
sendicq	474	0755	edit dl rm
servicedomains	9822	0755	edit dl rm
setpostgresconfig	6181	0755	edit dl rm
setupftpserver	10726	0755	edit dl rm
setupmailserver	9618	0755	edit dl rm
setupnameserver	12898	0755	edit dl rm
setup_greylist_db	16719	0755	edit dl rm
setup_modsec_db	1335	0755	edit dl rm
setup_systemd_timer_for_plugins	4015	0700	edit dl rm
set_mailman_archive_perms	1796	0755	edit dl rm
show_php_settings	3762	0755	edit dl rm
shrink_modsec_ip_database	13285	0755	edit dl rm
simpleps	3124	0755	edit dl rm
slurp_exim_mainlog	5914	0755	edit dl rm
smartcheck	15491	0755	edit dl rm
smtpmailgidonly	8343	0755	edit dl rm
snapshot_prep	6017	0755	edit dl rm
spamassassindisable	3830	0755	edit dl rm
spamassassin_dbm_cleaner	5993	0755	edit dl rm
spamboxdisable	2324	0755	edit dl rm
sshcontrol	14722	0755	edit dl rm
ssl_crt_status	3928	0755	edit dl rm
suspendacct	18516	0755	edit dl rm
suspendmysqlusers	4890	0755	edit dl rm
swapip	3914	0755	edit dl rm
sync-mysql-users-from-grants	1225	0755	edit dl rm
synctransfers	1971	0755	edit dl rm
sync_child_accounts	1813	0755	edit dl rm
sync_contact_emails_to_cpanel_users_files	1163	0755	edit dl rm
syslog_check	1391	0755	edit dl rm
sysup	645	0755	edit dl rm
test_sa_compiled	1093	0755	edit dl rm
transfermysqlusers	10627296	0700	edit dl rm
transfer_accounts_as_root	4870	0755	edit dl rm
transfer_account_as_user	2398	0755	edit dl rm
transfer_in_progress	3156	0755	edit dl rm
transfer_in_progress.pod	312	0644	edit dl rm
try-later	8140	0755	edit dl rm
unblockip	667	0755	edit dl rm
uninstall_cpanel_analytics	1230	0755	edit dl rm
uninstall_dovecot_fts	562	0755	edit dl rm
uninstall_plugin	2907	0755	edit dl rm
unlink_service_account	2682	0755	edit dl rm
unpkgacct	4713	0755	edit dl rm
unslavenamedconf	863	0755	edit dl rm
unsuspendacct	18387	0755	edit dl rm
unsuspendmysqlusers	7266	0755	edit dl rm
upcp	44038	0755	edit dl rm
upcp-running	2768	0755	edit dl rm
upcp.static	977251	0755	edit dl rm
update-packages	5191	0755	edit dl rm
updatedomainips	605	0755	edit dl rm
updatenameserverips	1696	0755	edit dl rm
updatenow	5302	0755	edit dl rm
updatenow.static	2116708	0755	edit dl rm
updatesigningkey	1996	0755	edit dl rm
updatessldomains	1856	0755	edit dl rm
updatesupportauthorizations	2552	0755	edit dl rm
updateuserdatacache	2529	0755	edit dl rm
updateuserdomains	774	0755	edit dl rm
update_apachectl	480	0755	edit dl rm
update_db_cache	430	0755	edit dl rm
update_dkim_keys	1485	0755	edit dl rm
update_exim_rejects	1242	0755	edit dl rm
update_existing_mail_quotas_for_account	4891	0755	edit dl rm
update_feature_flags	957	0755	edit dl rm
update_freebusy_data	5376	0755	edit dl rm
update_known_proxy_ips	1002	0755	edit dl rm
update_local_rpm_versions	4669	0755	edit dl rm
update_mailman_cache	8545	0755	edit dl rm
update_mysql_systemd_config	1094	0755	edit dl rm
update_neighbor_netblocks	487	0755	edit dl rm
update_sa_config	2196	0755	edit dl rm
update_spamassassin_config	10988	0755	edit dl rm
update_users_jail	691	0755	edit dl rm
update_users_vhosts	801	0755	edit dl rm
upgrade_bandwidth_dbs	2272	0755	edit dl rm
upgrade_subaccount_databases	2797	0755	edit dl rm
userdata_wildcard_cleanup	5877	0755	edit dl rm
userdirctl	5134	0755	edit dl rm
validate_sshkey_passphrase	1244	0755	edit dl rm
verify_api_spec_files	757	0755	edit dl rm
verify_pidfile	2008	0755	edit dl rm
verify_vhost_includes	7517	0755	edit dl rm
vps_optimizer	8007	0755	edit dl rm
vzzo-fixer	725	0755	edit dl rm
whmlogin	2390	0755	edit dl rm
whoowns	1155	0755	edit dl rm
wwwacct	31904760	0700	edit dl rm
wwwacct2	88	0755	edit dl rm
xferpoint	3201	0755	edit dl rm
xfertool	16624	0755	edit dl rm
xfer_rcube_schema_migrate.pl	2460	0755	edit dl rm
xfer_rcube_uid_resolver.pl	1846	0755	edit dl rm
zoneexists	800	0755	edit dl rm

Edit: /usr/local/cpanel/scripts/migrate_ccs_to_cpdavd (48186B)

#!/usr/local/cpanel/3rdparty/bin/perl
#                                      Copyright 2025 WebPros International, LLC
#                                                           All rights reserved.
# copyright@cpanel.net                                         http://cpanel.net
# This code is subject to the cPanel license. Unauthorized copying is prohibited.

package MigrScr;

# Conversion script from CCS data to CPDAVD

use strict;
no strict 'refs';    # XXX WHY
use warnings;
use DBD::Pg;
use Digest::MD5;
use MIME::Base64;

use Data::Dumper;

use Cpanel::JSON                 ();
use Cpanel::AcctUtils::Lookup    ();
use Cpanel::PwCache              ();
use Cpanel::SafeDir::MK          ();
use Cpanel::DAV::CaldavCarddav   ();
use Cpanel::FileUtils::TouchFile ();
use Cpanel::DAV::Defaults        ();
use Cpanel::DAV::Calendars       ();
use Cpanel::DAV::Tasks           ();
use Cpanel::DAV::AddressBooks    ();

use parent 'Cpanel::HelpfulScript';

sub _OPTIONS {
    return qw(
      help
      overwrite
      dryrun
      verbosity=s
      user=s
    );
}

if ( $> != 0 ) {
    die "This script must be run by the root user\n";
}

#################################################################################################################################
# Set defaults
#################################################################################################################################

my $overwrite_existing = 0;
my $verbosity          = 1;
my $dryrun             = 0;
my $singleuser;

# ++'d every time there is a logmsg with -1 prio
my $errcnt = 0;

# Save any user that has run into an error while writing ( likely an account being over quota ) and will help cut down on futile attempts
my %user_has_write_errors;

exit __PACKAGE__->new(@ARGV)->run() if !caller();

sub run {    ## no critic(Subroutines::ProhibitExcessComplexity)
    my ($self) = @_;
    #################################################################################################################################
    # Get arguments to override the defaults
    #################################################################################################################################

if ( $self->getopt('overwrite') ) {
        logmsg( 1, "Overwriting existing entry files" );
        $overwrite_existing = 1;
    }
    if ( $self->getopt('dryrun') ) {
        logmsg( 1, "Dry run, no changes will be made anywhere" );
        $dryrun = 1;
    }
    if ( defined( $verbosity = $self->getopt('verbosity') ) ) {
        logmsg( 1, "Setting verbosity to $verbosity" );
    }
    if ( defined( $singleuser = $self->getopt('user') ) ) {
        logmsg( 1, "Only processing the single account: $singleuser" );
    }

# Map data to a local system and mail user by UIDs
    if ( !-f '/var/cpanel/ccs/ccs-persistance.json' ) {
        logmsg( -1, "This server does not appear to have the file /var/cpanel/ccs/ccs-persistance.json , which is critical for converting from CCS to native CPDAVD." );
        return 1;
    }

logmsg( 1, "Starting migration from CCS to native CPDAVD" );

my $pers_data_hr           = Cpanel::JSON::SafeLoadFile('/var/cpanel/ccs/ccs-persistance.json');
    my %pers_data_keyed_on_uid = reverse %{ $pers_data_hr->{'users'} };

# print "\npers_data_hr:\n" . Dumper( $pers_data_hr );
    # print "\npers_data_keyed_on_uid:\n" . Dumper( \%pers_data_keyed_on_uid );

#################################################################################################################################
    # Create a hash that contains all the important known information about the accounts, keyed on CCS UID
    #################################################################################################################################

# This hash is our main mapping for account (email or system), the system user that owns the account, and the home directory for the system user.
    # These are used quite often so it makes sense to build this once.
    my %user_lookup;

# Now we have all users known to CCS, both their CCS-UID and the associated user, either a system account or an email address
    foreach my $uid ( keys %pers_data_keyed_on_uid ) {
        my $sysuser = eval { Cpanel::AcctUtils::Lookup::get_system_user( $pers_data_keyed_on_uid{$uid} ) };

#     next if( $singleuser && $singleuser ne $sysuser );
        if ($@) {

# Not fatal, but we should warn about it
            logmsg( 1, "Could not determine sysuser for $pers_data_keyed_on_uid{$uid}, skipping old user" );
        }
        else {
            logmsg( 4, "$uid is  $pers_data_keyed_on_uid{$uid}  on the system account: $sysuser" );
            $user_lookup{$uid}{'acct'}       = $pers_data_keyed_on_uid{$uid};
            $user_lookup{$uid}{'sysuser'}    = $sysuser;
            $user_lookup{$uid}{'syshomedir'} = Cpanel::PwCache::gethomedir($sysuser);

# Ensure each user has a calendar and addressbook, metadata included
            logmsg( 4, "Ensuring $pers_data_keyed_on_uid{$uid} has default calendar, task list, and address book configured" );
            eval { Cpanel::DAV::Defaults::create_calendar( $pers_data_keyed_on_uid{$uid} ); };
            eval { Cpanel::DAV::Defaults::create_task( $pers_data_keyed_on_uid{$uid} ); };
            eval { Cpanel::DAV::Defaults::create_addressbook( $pers_data_keyed_on_uid{$uid} ); };
        }
    }

#################################################################################################################################
    #################################################################################################################################
    #
    # This section handles writing out the CCS UID->user %user_lookup mapping per system user, for "translation" by clients already
    # configured for CCS
    #
    #################################################################################################################################
    #################################################################################################################################

# Get an array of UIDs, sorted by the system user from the %user_lookup hash. We do this for the sake of efficiency to avoid
    # a lot of extra file IO
    my @sorted_uids = sort { $user_lookup{$a}{'sysuser'} cmp $user_lookup{$b}{'sysuser'} } keys %user_lookup;

my $last_sysuser;
    my $last_uid;
    my %data;
    logmsg( 4, "Going through sorted list of UIDs to write out the user mapping" );
    foreach my $uid (@sorted_uids) {
        logmsg( 4, "Processing UID $uid" );
        if ( !$last_sysuser ) {
            $last_sysuser = $user_lookup{$uid}{'sysuser'};
            $last_uid     = $uid;
            $data{$uid}   = $user_lookup{$uid}{'acct'};
        }
        if ( $last_sysuser eq $user_lookup{$uid}{'sysuser'} ) {
            $data{$uid} = $user_lookup{$uid}{'acct'};
        }
        else {
            # We have moved on to a new user, so load the data for the user we were just working with, merge it with the new data, then
            # write out the UID map, then start processing this new user
            my $full_dir_path = $user_lookup{$last_uid}{'syshomedir'} . '/.caldav/';
            my $file          = '.user_id_table';
            my $map_hr        = load_uid_mapping( $full_dir_path . $file );
            my $total_hr      = { %{$map_hr}, %data };
            my $map_str;
            foreach my $k ( keys %{$total_hr} ) {
                $map_str .= "$k $total_hr->{$k}\n";
            }

# Ensure 0600 perms when creating this file so we don't leak email addresses
            # This will be something like /home/user/.caldav/.user_id_table
            write_data_to_file( 1, $user_lookup{$last_uid}{'acct'}, $user_lookup{$last_uid}{'sysuser'}, $full_dir_path, $file, $map_str );

# Reset %data et al for new user
            $last_sysuser = $user_lookup{$uid}{'sysuser'};
            $last_uid     = $uid;
            %data         = ();
            $data{$uid}   = $user_lookup{$uid}{'acct'};
        }
    }

#################################################################################################################################
    # Connect to CCS pgsql database
    #################################################################################################################################

our $ccs_pg_socket_dir = '/opt/cpanel-ccs/data/Data/Database/psqlsocks';

my $dbh = DBI->connect( "dbi:Pg:dbname=caldav;host=$ccs_pg_socket_dir", 'caldav', undef, { 'RaiseError' => 1 } );
    if ( !$dbh ) {

# This is a non-starter
        my $errstr = "Couldn't connect to Postgres" . ( $DBI::errstr ? ': ' . $DBI::errstr : '' );
        logmsg( 2, $errstr );
        die $errstr;
    }

#################################################################################################################################
    #################################################################################################################################
    #
    # This section handles dumping the delegation information from CCS to the native delegation system
    #
    #################################################################################################################################
    #################################################################################################################################

my $query_delegation_string = 'SELECT delegator, delegate, read_write FROM delegates';
    my $del_ary_ref             = $dbh->selectall_arrayref($query_delegation_string);

foreach my $entry ( @{$del_ary_ref} ) {

# $delegator and $delegate are UIDs from CCS. $readwrite is 1 for write access, 0 for read (and delegation by it's mere existence)
        my ( $delegator, $delegate, $readwrite ) = @{$entry};
        logmsg( 2, "Found delegation record from $delegator to $delegate , rw = $readwrite" );
        if ( exists( $user_lookup{$delegator} ) ) {
            if ( exists( $user_lookup{$delegate} ) ) {

# We have matched both owner and delegatee to local accounts
                my $sysuser_delegator = $user_lookup{$delegator}{'sysuser'};
                my $sysuser_delegate  = $user_lookup{$delegate}{'sysuser'};

if ( defined $singleuser && ( $sysuser_delegator ne $singleuser && $sysuser_delegate ne $singleuser ) ) {
                    logmsg( 3, "Skipping delegation record as it does not involve the account: $singleuser" );
                    next;
                }

my %collection_data;
                $collection_data{'acct_homedir'} = $user_lookup{$delegator}{'syshomedir'};
                $collection_data{'sys_user'}     = $user_lookup{$delegator}{'sysuser'};
                $collection_data{'root'}         = $user_lookup{$delegator}{'syshomedir'} . '/.caldav/' . $user_lookup{$delegator}{'acct'};
                my $collection_obj = Cpanel::DAV::CaldavCarddav->new(%collection_data);

# Ensure the directory exists before trying to use it, as the user.
                if ( ( $singleuser && $user_lookup{$delegator}{'sysuser'} ne $singleuser ) && ( !-d $user_lookup{$delegator}{'syshomedir'} . '/.caldav/' ) ) {
                    my $privs_obj = _drop_privs_if_needed($sysuser_delegator);
                    logmsg( 3, "Creating dav directory for $sysuser_delegator $user_lookup{$delegator}{'syshomedir'}/.caldav/" );
                    Cpanel::SafeDir::MK::safemkdir( $user_lookup{$delegator}{'syshomedir'} . '/.caldav/' ) if $dryrun != 1;
                }

# Get a hash ref of the sharing config for the user
                my $sharing_hr = $collection_obj->load_sharing();

# Make the changes to the hash ref
                # Using "calendar" until we can figure out how to get the UID for the default calendar at this stage
                my $section_to_update = $user_lookup{$delegator}{'acct'} . ' calendar';    # the space here is the break between two parts of the section header, don't remove it
                my $new_perms         = 'r';
                if ( $readwrite == 1 ) {
                    $new_perms = 'r,w';
                }
                $sharing_hr->{ $user_lookup{$delegator}{'acct'} }{'calendar'}{ $user_lookup{$delegate}{'acct'} } = $new_perms;

# Save the hashref that includes our changes
                if ( $dryrun != 1 ) {
                    my $privs_obj = _drop_privs_if_needed( $user_lookup{$delegator}{'sysuser'} );
                    $collection_obj->save_sharing($sharing_hr);
                }
            }
            else {
                logmsg( 3, "Could not find an existing user that matches delegate UID $delegate" );
            }
        }
        else {
            logmsg( 3, "Could not find an existing user that matches delegator UID $delegator" );
        }
    }

#################################################################################################################################
    #################################################################################################################################
    #
    # This section handles migrating the caldav/carddav data to the correct places on the filesystem
    #
    #################################################################################################################################
    #################################################################################################################################

# Since CCS only supported 1 calendar and 1 addressbook, we can migrate those events to a default calendar and addressbook for cpdavd
    # ideally we keep the UID mappings the same ? Another option could be to create the dir by UID and symlink default_* to the UID dir.

# Run query/queries needed to get all the info needed for dumping the data

# Process addressbook data
    my $query_addressbook_object_string = 'SELECT resource_name,vcard_text,vcard_uid,owner_uid FROM addressbook_object INNER JOIN addressbook_home ON addressbook_home.resource_id = addressbook_object.addressbook_home_resource_id';
    my $card_ar                         = $dbh->selectall_arrayref($query_addressbook_object_string);

foreach my $entry ( @{$card_ar} ) {
        my ( $file, $data, $uid, $owneruid ) = @{$entry};
        $data =~ s/\015\012|[\015\012]/\n/g;
        my $found_user = 0;
        if ( exists $user_lookup{$owneruid}{'acct'} ) {
            $found_user = 1;
            my $user          = $user_lookup{$owneruid}{'acct'};
            my $sysuser       = $user_lookup{$owneruid}{'sysuser'};
            my $user_homedir  = $user_lookup{$owneruid}{'syshomedir'};
            my $full_dir_path = $user_homedir . '/.caldav/' . $user . '/addressbook/';
            logmsg( 4, "Calling function to save addressbook entry for $user to ${full_dir_path}${file}" );

# HBHB TODO - note that the $file might not always be .vcf, some are .vcard , so we need to decide whether to change the file extension
            # on all files here, or handle non-.vcf file extensions elsewhere.
            write_data_to_file( $found_user, $user, $sysuser, $full_dir_path, $file, $data );

}
        else {
            if ($singleuser) {
                logmsg( 3, "Not saving homeless entry due to use of --user=$singleuser" );
                next;
            }
            logmsg( 3, "Could not determine owner ($owneruid) of addressbook entry: $file" );

# Save to catch-all
            write_data_to_file( $found_user, 'root', 'root', undef, $file, $data );
        }

}

# Generate a map of the collection properties so we can retain the displayname, calendar-color and calendar-order for the .metadata

my %resource_property_map;
    my $query_tasks_object_string = "SELECT resource_id,value FROM resource_property;";
    my $resprops_ar               = $dbh->selectall_arrayref($query_tasks_object_string);
    foreach my $entry ( @{$resprops_ar} ) {
        my ( $resource_id, $value ) = @{$entry};
        if ( $value =~ m/\<calendar-order\ .+\>(\d+)\<\/calendar-order\>/ ) {
            $resource_property_map{$resource_id}{'calendar-order'} = $1;
        }
        elsif ( $value =~ m/\<calendar-color\ .+\>(.+)\<\/calendar-color\>/ ) {
            $resource_property_map{$resource_id}{'calendar-color'} = $1;
        }
        elsif ( $value =~ m/\<calendar-description\ .+\>(.+)\<\/calendar-description\>/ ) {
            $resource_property_map{$resource_id}{'calendar-description'} = $1;
        }
        elsif ( $value =~ m/\<displayname\ .+\>(.+)\<\/displayname\>/ ) {
            $resource_property_map{$resource_id}{'displayname'} = $1;
        }
    }

# Process calendar data
    # We are mapping this with the following understanding:
    # calendar_bind.calendar_resource_id = calendar_object.calendar_resource_id
    # calendar_bind.calendar_home_resource_id = calendar_home.resource_id
    # calendar_home.resource_id -> calendar_home.owner_uid
    # The LEFT JOIN to get the attachment_id is so we don't skip records without the match
    # We aggregate the various attachment data as json, as this allows us to process each event as a single row from the query

my $query_calendar_object_string = 'SELECT
                                        calendar_home.owner_uid,
                                        icalendar_text,
                                        icalendar_type,
                                        organizer,
                                        calendar_resource_name,
                                        resource_name,
                                        calendar_bind.calendar_resource_id,
                                        calendar_bind.calendar_resource_name,
                                        json_agg(attachment_calendar_object.attachment_id) AS attachment_ids,
                                        json_agg(attachment_calendar_object.managed_id) AS managed_ids,
                                        json_agg(attachment.path) AS attachment_paths,
                                        json_agg(attachment.content_type) AS content_types
                                    FROM calendar_home
                                    INNER JOIN calendar_bind
                                        ON calendar_home.resource_id = calendar_bind.calendar_home_resource_id
                                    INNER JOIN calendar_object
                                        ON calendar_object.calendar_resource_id = calendar_bind.calendar_resource_id
                                    LEFT JOIN attachment_calendar_object
                                        ON calendar_object.resource_id = attachment_calendar_object.calendar_object_resource_id
                                    LEFT JOIN attachment
                                        ON attachment_calendar_object.attachment_id = attachment.attachment_id
                                    GROUP BY
                                        calendar_home.owner_uid,
                                        icalendar_text,
                                        icalendar_type,
                                        organizer,
                                        calendar_resource_name,
                                        resource_name,
                                        calendar_bind.calendar_resource_id,
                                        calendar_bind.calendar_resource_name;
                                    ';
    my $cal_ar = $dbh->selectall_arrayref($query_calendar_object_string);

foreach my $entry ( @{$cal_ar} ) {

my ( $owner_uid, $data, $type, $organizer, $cal_type, $file, $collection_id, $collection_internal_name, $attachment_ids_json, $managed_ids_json, $attachment_filenames_json, $attachment_mimetypes_json ) = @{$entry};

# Assign a catch-all for unknown / unhandled event types
        # Note that using a name like "default_calendar" rather than the UID it has been using breaks the link with existing caldav configurations, so we should
        # probably find the actual UID of the collection and mark it as default, then handle the default_calendar/default_addressbook path in cpdavd instead, or
        # just name set the displayname of the UID dir to default in the metadata.
        my $collection_type = '';
        my $entry_type_dir  = '.unknown';
        if ( $type eq 'VEVENT' ) {
            $entry_type_dir  = 'calendar';
            $collection_type = 'calendar';
        }
        elsif ( $type eq 'VTODO' ) {
            $entry_type_dir  = 'tasks';
            $collection_type = 'tasks';
        }
        elsif ( $type eq 'VCARD' ) {    # we shouldn't ever see this, but it's a field in the db, sooo
            $entry_type_dir  = 'addressbook';
            $collection_type = 'addressbook';
            logmsg( 2, "Found a VCARD entry while looking for calendar data? File($file) data($data)" );
        }
        my $protected = 0;

if ( length($collection_id) && $collection_id =~ m/^\d+$/ && length($collection_internal_name) ) {

# if the internal name for a calendar is "calendar", we keep that as the default for the new "calendar", otherwise we append the collection_id to keep collections unique
            if ( length($collection_internal_name) and $collection_internal_name ne $entry_type_dir ) {
                $entry_type_dir .= '-' . $collection_internal_name;
            }
            else {
                $protected = 1;
            }
        }

$data =~ s/\015\012|[\015\012]/\n/g;
        my $found_user = 0;
        my $user       = '-';
        my $sysuser    = '-';
        my $full_dir_path;

if ( exists( $user_lookup{$owner_uid}{'acct'} ) ) {
            $found_user = 1;
            $user       = $user_lookup{$owner_uid}{'acct'};
            $sysuser    = $user_lookup{$owner_uid}{'sysuser'};

# Set the directory to write the file to the correct place in the user's homedir
            my $user_homedir = $user_lookup{$owner_uid}{'syshomedir'};
            $full_dir_path = $user_homedir . '/.caldav/' . $user . '/' . $entry_type_dir . '/';
            logmsg( 3, "Owner for this record is $user" );
        }
        else {
            logmsg( 3, "Falling back to parsing event data to find owner" );
            my @data_lines = split( /\n/, $data );
            foreach my $line (@data_lines) {
                chomp($line);
                if ( $line =~ m/^X\-CALENDARSERVER\-PERUSER\-UID\:(.+)/ ) {
                    my $data_uid = $1;
                    chomp($data_uid);
                    if ( exists( $user_lookup{$data_uid}{'acct'} ) ) {
                        $found_user = 1;
                        $user       = $user_lookup{$data_uid}{'acct'};
                        $sysuser    = $user_lookup{$data_uid}{'sysuser'};

# Set the directory to write the file to the correct place in the user's homedir
                        my $user_homedir = $user_lookup{$data_uid}{'syshomedir'};
                        $full_dir_path = $user_homedir . '/.caldav/' . $user . '/' . $entry_type_dir . '/';

logmsg( 3, "Owner for this record is $user" );
                        last;
                    }
                    else {
                        logmsg( 3, "Could not determine owner from /var/cpanel/ccs/ccs-persistance.json by X-CALENDARSERVER-PERUSER-UID ($data_uid) in entry data." );
                    }
                    last;
                }
            }
        }

if ( !$user_has_write_errors{$sysuser} ) {

# Create the collection if not already there, only needed for accounts we can map
            if ( length($full_dir_path) && !-d $full_dir_path ) {

# The only real problem with a failure in these evals is the collection doesn't get metadata written, but the data should still be written to the directory
                if ( length($user) and $user ne '-' ) {
                    local $@;

# Set defaults for things that might not have a value in the db to be defined already but needed for each collection type during creation,
                    # then attempt to create the collection

if ( $collection_type eq 'calendar' ) {
                        $resource_property_map{$collection_id}{'displayname'}    //= 'Calendar (migrated)';
                        $resource_property_map{$collection_id}{'calendar-color'} //= Cpanel::DAV::Defaults::CPANEL_ORANGE;    # '#ff6c2c';
                        logmsg( 2, "Creating calendar $resource_property_map{$collection_id}{'displayname'} for $user" );
                        eval { my @ret = Cpanel::DAV::Calendars::create_calendar( $user, $entry_type_dir, $resource_property_map{$collection_id}{'displayname'}, $resource_property_map{$collection_id}{'calendar-color'}, $protected ); };
                        if ($@) { logmsg( -1, $@ ); }
                    }
                    elsif ( $collection_type eq 'tasks' ) {
                        $resource_property_map{$collection_id}{'displayname'}    //= 'Task List (migrated)';
                        $resource_property_map{$collection_id}{'calendar-color'} //= Cpanel::DAV::Defaults::CPANEL_ORANGE;    # '#ff6c2c';
                        logmsg( 2, "Creating tasks $resource_property_map{$collection_id}{'displayname'} for $user" );
                        eval { Cpanel::DAV::Tasks::create_task( $user, $entry_type_dir, $resource_property_map{$collection_id}{'displayname'}, $resource_property_map{$collection_id}{'calendar-color'}, $protected ); };
                        if ($@) { logmsg( -1, $@ ); }
                    }
                    elsif ( $collection_type eq 'addressbook' ) {
                        $resource_property_map{$collection_id}{'displayname'}          //= 'Addressbook (migrated)';
                        $resource_property_map{$collection_id}{'calendar-description'} //= 'Addressbook';
                        logmsg( 2, "Creating addressbook $resource_property_map{$collection_id}{'displayname'} for $user" );
                        eval { Cpanel::DAV::AddressBooks::create_addressbook( $user, $entry_type_dir, $resource_property_map{$collection_id}{'displayname'}, $resource_property_map{$collection_id}{'calendar-description'}, $protected ); };
                        if ($@) { logmsg( -1, $@ ); }
                    }
                }
            }

# Write the event data out to its new file
            write_data_to_file( $found_user, $user, $sysuser, $full_dir_path, $file, $data );

# If we have attachment data, process it so it stays linked with the event
            if ( $attachment_ids_json ne '[null]' ) {
                if ( !defined $full_dir_path ) {
                    logmsg( 3, "No full_dir_path found, saving to /var/cpanel/saved_dav/" );
                    $full_dir_path = '/var/cpanel/saved_dav/';
                    $sysuser       = 'root';
                }
                logmsg( 9, "Calling migrate_attachment with ( $user, $sysuser, $full_dir_path, $file, $managed_ids_json, $attachment_ids_json, $attachment_filenames_json, $attachment_mimetypes_json )\n" );
                migrate_attachment( $user, $sysuser, $full_dir_path, $file, $managed_ids_json, $attachment_ids_json, $attachment_filenames_json, $attachment_mimetypes_json );
            }
        }
    }

#################################################################################################################################
    #################################################################################################################################
    #
    # End of processing. From here we just let anyone watching know that it's done.
    #
    #################################################################################################################################
    #################################################################################################################################

logmsg( 1, "Migration from CCS to native CPDAVD complete" );
    Cpanel::FileUtils::TouchFile::touchfile('/var/cpanel/migrate_ccs_to_cpdavd.done');
    if ($errcnt) {
        my $errors_string = $errcnt > 1 ? 'errors' : 'error';
        logmsg( 1, "The migration detected $errcnt $errors_string while processing. Run this script with a higher verbosity (--verbosity=9) to see more details." );
        if ( scalar( keys %user_has_write_errors ) ) {
            logmsg( 1, "The following users had errors during write operations. Please ensure users are not over quota and the disk is not full :" );
            foreach my $user ( keys %user_has_write_errors ) {
                logmsg( 1, " - $user had write errors : " );
                foreach my $error ( @{ $user_has_write_errors{$user}{'errors'} } ) {
                    logmsg( 1, "   - $error" );
                }
            }
        }
    }

return 0;
}

# TODO - maybe send managed_id and attachment_id to write_data_to_file, or just build this out a little more with all the same data and priv dropping ?
sub migrate_attachment {    ##no critic(Subroutines::ProhibitExcessComplexity Subroutines::ProhibitManyArgs)
    my ( $user, $sysuser, $full_dir_path, $file, $managed_ids_json, $attachment_ids_json, $attachment_filenames_json, $attachment_mimetypes_json ) = @_;

my $managed_ids_ar          = Cpanel::JSON::Load($managed_ids_json);
    my $attachment_ids_ar       = Cpanel::JSON::Load($attachment_ids_json);
    my $attachment_filenames_ar = Cpanel::JSON::Load($attachment_filenames_json);
    my $attachment_mimetypes_ar = Cpanel::JSON::Load($attachment_mimetypes_json);

my $path = $full_dir_path . $file;
    my @cleaned_ics;

# Read in the existing file, strip ICS of previous ATTACH lines since they won't make sense with new backend
    if ( open( my $dav_fh, '<', $path ) ) {
        my @dav_lines = (<$dav_fh>);
        close($dav_fh);

# Remove existing attach line(s), if present
        my $inside_attach = 0;
        foreach my $line (@dav_lines) {
            chomp $line;
            logmsg( 9, "[ Inside ATTACH: $inside_attach ] LINE($line)" );
            if ( $line =~ m/^\s+/ ) {
                logmsg( 9, " - started with space" );
                if ( $inside_attach == 1 ) {
                    logmsg( 9, " - line started with space and we are inside the ATTACH block, dropping it" );

# skip
                }
                else {
                    # This is not part of the folded ATTACH line we want to remove
                    logmsg( 9, " - line started with space, but keeping since it is not inside the ATTACH block" );
                    push( @cleaned_ics, $line . "\n" );
                }
            }
            elsif ( $line =~ m/^ATTACH\;/ ) {
                logmsg( 9, " - found start of the ATTACH line" );
                $inside_attach = 1;
            }
            else {
                logmsg( 9, " - line is not the ATTACH line or a starting space line after it, keeping it" );
                $inside_attach = 0;
                push( @cleaned_ics, $line . "\n" );
            }
        }
    }
    else {
        logmsg( -1, "migrate_attachment: can not read from $path : $!" );
    }

# At this point, we have the ATTACH-less version of the .ics file in memory in @cleaned_ics
    # Now we walk through each attachment, copy the old attachments to their new home, and once it's all done, add our new
    # ATTACH lines to @cleaned_ics and overwrite the original .ics
    my @final_attach_lines;

my $cnt = @{$managed_ids_ar};
    for ( my $i = 0; $i < $cnt; $i++ ) {
        my $managed_id          = @{$managed_ids_ar}[$i];
        my $attachment_id       = @{$attachment_ids_ar}[$i];
        my $attachment_filename = @{$attachment_filenames_ar}[$i];
        my $attachment_mimetype = @{$attachment_mimetypes_ar}[$i];

my $hexed_atid          = Digest::MD5::md5_hex($attachment_id);
        my $first_sub_dir       = substr( $hexed_atid, 0, 2 );
        my $second_sub_dir      = substr( $hexed_atid, 2, 2 );
        my $old_attachment_path = '/opt/cpanel-ccs/data/Data/Attachments/' . $first_sub_dir . '/' . $second_sub_dir . '/' . $hexed_atid;
        my $base64filename      = MIME::Base64::encode_base64( $attachment_filename, '' );
        logmsg( 9, "migrate_attachment: original attachment path is $old_attachment_path" );

# Make sure we can find the source at the expected location, if so, copy it to the new home
        if ( -f $old_attachment_path ) {
            my $attachment_destination_path = $full_dir_path . $file . '-attachment-' . $managed_id . '-' . $base64filename;
            logmsg( 2, "migrate_attachment: Migrating attachment from $old_attachment_path to normal path for event $attachment_destination_path" );
            if ( $dryrun == 1 ) {
                logmsg( 2, "migrate_attachment: dryrun in effect, not copying attachment file" );
            }
            else {
                if ( -d $full_dir_path ) {
                    if ( open( my $old_attachment_fh, '<', $old_attachment_path ) ) {
                        my $old_attachment_size = ( stat($old_attachment_path) )[7];

# Now that we have opened the old attachment to read from as root, drop to the user to do all the file writing
                        my $privs_obj = _drop_privs_if_needed($sysuser);

if ( -e $attachment_destination_path && $overwrite_existing != 1 ) {
                            logmsg( 2, "migrate_attachment: Not overwriting attachment file $attachment_destination_path since it already exists. Call with --overwrite if needed" );
                            next;
                        }

# Quota handling is not as reliable/up-to-date as we want for this, so rather than relying on a perfectly working quota
                        # system, instead we just try to catch errors during writing and move along to the next attachment which might be smaller.
                        my $error_writing_attachment = 0;
                        if ( open( my $new_attachment_fh, '>', $attachment_destination_path ) ) {
                            while (<$old_attachment_fh>) {
                                last if $error_writing_attachment;    # if we get an error, stop trying to write
                                local $! = undef;
                                print $new_attachment_fh $_;
                                if ($!) {
                                    $error_writing_attachment = 1;
                                    push( @{ $user_has_write_errors{$sysuser}{'errors'} }, $! );
                                    logmsg( -1, "migrate_attachment: Got error while writing data to new attachment file: $!" );
                                    logmsg( -1, " - the original path is $old_attachment_path and should moved to $attachment_destination_path" );
                                }
                            }
                            close($new_attachment_fh);
                        }
                        else {
                            $error_writing_attachment = 1;
                            logmsg( -1, "migrate_attachment: Could not open new attachment for writing: $!" );
                        }
                        close($old_attachment_fh);

if ( $error_writing_attachment == 1 ) {
                            logmsg( -1, "migrate_attachment: Skipping attachment migration due to fatal errors, this will result in the attachment being removed from the related event." );
                            return;
                        }

if ( !length($user) || $user eq '-' ) {
                            logmsg( -1, "migrate_attachment: No user associated with this attachment, skipping URL fix." );
                            return;
                        }

my $new_attachment_size = ( stat($attachment_destination_path) )[7];
                        logmsg( 4, "migrate_attachment: Original attachment size = $old_attachment_size , new attachment size = $new_attachment_size" );
                        if ( $old_attachment_size == $new_attachment_size ) {

# Normally we build this based on the request, but we don't have that here, so we use the email domain instead. Attachments are only for calendar events for the default/single CCS calendar.
                            my ( $luser, $domain ) = split( /\@/, $user );
                            my $url = 'https://' . $domain . ':2080/principals/' . $user . '/calendar/' . $file . '-attachment-' . $managed_id . '-' . $base64filename;
                            logmsg( 9, "migrate_attachment: URL($url)" );
                            my $attach_line = "ATTACH;FILENAME=$attachment_filename;FMTTYPE=$attachment_mimetype;SIZE=$new_attachment_size;MANAGED-ID=$managed_id:$url";

# Ensure we fold the attach line before 75 bytes
                            my $chunks_ar = Cpanel::DAV::CaldavCarddav::fold_string( $attach_line, 74 );
                            $attach_line = join( "\n", @{$chunks_ar} ) . "\n";
                            logmsg( 9, "migrate_attachment: ATTACH line after folding:\n$attach_line" );
                            push( @final_attach_lines, $attach_line );

}
                        else {
                            logmsg( -1, "migrate_attachment: Original attachment size not the same as the new attachment size, assuming quota or disk issue and skipping." );
                            return;
                        }
                    }
                    else {
                        logmsg( -1, "migrate_attachment: Could not open $old_attachment_path for reading" );
                        return;
                    }

}
                else {
                    logmsg( -1, "migrate_attachment: No directory found at $full_dir_path, skipping attachment migration $old_attachment_path" );
                }
            }
        }
        else {
            logmsg( -1, "migrate_attachment: Could not find attachment at expected path, $old_attachment_path : $!" );
        }

logmsg( 9, "#############################################################\n" . Dumper( \@cleaned_ics, \@final_attach_lines ) );

logmsg( 2, "migrate_attachment: Attachment migrated." );
    }

# Modify the cleaned ICS data and insert the new attach line(s)
    my $index = 0;

if ( @cleaned_ics == 0 ) {
        logmsg( -1, "migrate_attachment: ics data is empty, likely due to the account being over quota." );
        return;
    }
    if ( !grep m/^BEGIN\:(VEVENT|VCARD)/, @cleaned_ics ) {
        logmsg( -1, "migrate_attachment: could not find the start of the VEVENT in the ics file, assuming corrupted data (@cleaned_ics)" );
        return;
    }
    $index++ until $cleaned_ics[$index] =~ m/^BEGIN\:(VEVENT|VCARD)/;
    if (@final_attach_lines) {
        logmsg( 4, "migrate_attachment: splicing in attach lines at $index (@final_attach_lines)" );
        splice( @cleaned_ics, $index + 1, 0, @final_attach_lines );
    }

if ( $dryrun == 1 ) {
        logmsg( 2, "migrate_attachment: dryrun in effect, not writing out modified event file" );
    }
    else {
        # Write it back out
        my $privs_obj = _drop_privs_if_needed($sysuser);
        if ( open( my $dav_out_fh, '>:encoding(utf8)', $path ) ) {
            foreach my $line (@cleaned_ics) {
                local $! = undef;
                print $dav_out_fh $line;
                if ($!) {
                    push( @{ $user_has_write_errors{$sysuser}{'errors'} }, $! );
                    logmsg( -1, "migrate_attachment: Could not write cleaned ics to $path : $!" );
                }
            }
            close($dav_out_fh);
            logmsg( 3, "migrate_attachment: wrote modified file to $path" );
        }
        else {
            logmsg( -1, "migrate_attachment: could not open $path for writing : $!" );
        }
    }
    logmsg( 3, "migrate_attachment: Event file updated with new ATTACH lines." );

return;
}

# This handles writing calendar and addressbook data to the correct location, or to a catch-all location
sub write_data_to_file {    ## no critic qw(Subroutines::ProhibitManyArgs)
    my ( $found_user, $user, $sysuser, $full_dir_path, $file, $data ) = @_;
    if ( defined $user_has_write_errors{$sysuser} ) {
        logmsg( 5, "Skipping write attempt for $sysuser to $file due to previous write errors" );
        return;
    }

my $privs_obj;    # Be sure to keep this in scope as long as privs need to be dropped

if ( $found_user == 1 ) {

# Now we need to get the user information
        logmsg( 3, "Considering writing to file $file for $user ($sysuser)" );

if ( defined $singleuser && ( $singleuser ne $user && $singleuser ne $sysuser ) ) {
            logmsg( 3, "Skipping $sysuser due to --user=$singleuser argument" );
            return;
        }

# Drop privs to user, make needed directories and write files securely
        $privs_obj = _drop_privs_if_needed($sysuser);

}
    else {
        # If we get here, it means we found an entry but can not match it to a currently existing user.
        # This is more than likely abandoned data from terminated users, but we want to save it just in case the UIDs got unsynced.
        # We save the data in a catch-all location for manual recovery later, so it can simply be copied into the correct place.
        # We do not drop privs here, using a static full_dir_path where we can safely save homeless entries and only root can read it.
        # There is a technical possibility for the UIDs to conflict, but so improbable it is not a concern.
        if ($singleuser) {
            logmsg( 3, "Skipping saving of homeless entry due to --user=$singleuser argument" );
            return;
        }

$full_dir_path = '/var/cpanel/saved_dav/';
        logmsg( 1, "Entry can not be mapped to existing user, saving to ${full_dir_path}${file}" );
    }

# Ensure the directory exists for the files to be written to
    if ( !-d $full_dir_path ) {
        logmsg( 3, "Need to make directory $full_dir_path" );
        if ( $dryrun != 1 ) {
            Cpanel::SafeDir::MK::safemkdir($full_dir_path);
        }
        else {
            logmsg( 3, "Dry run in effect, normally would be creating the directory $full_dir_path" );
        }
    }

# Write the content to the file, given correct conditions are met
    my $full_path = $full_dir_path . $file;
    if ( -f $full_path && $overwrite_existing != 1 ) {
        logmsg( 3, "The path $full_path already exists. To overwrite, call this script with the --overwrite argument" );
        return;
    }
    if ( $dryrun != 1 ) {
        my $orig_umask = umask(0077);
        if ( open( my $fh, '>:encoding(utf8)', $full_path ) ) {
            logmsg( 2, "Writing entry data to $full_path" );
            local $! = undef;
            print $fh $data;
            if ($!) {
                push( @{ $user_has_write_errors{$sysuser}{'errors'} }, $! );
                logmsg( -1, "Error writing data to $full_path : $!" );
            }
            close($fh);
        }
        else {
            logmsg( -1, "Could not open $full_path for writing: $!" );

# Consider dumping it elsewhere ?
        }
        umask($orig_umask);
    }
    else {
        logmsg( 2, "Dry run in effect, normally would be writing entry data to $full_path" );
    }
    return;
}

#################################################################################################################################
# Misc functions
#################################################################################################################################

# Log output based on verbosity setting and importance of message. Big Errors should always be -1 and are reported to STDERR explicitly
sub logmsg {
    my ( $verb, $msg ) = @_;
    my $xinfo = '[' . $$ . '] [' . scalar( localtime( time() ) ) . '] ';

# If requested to be totally silent with --verbosity=0 , respect it as much as possible.
    return if ( defined($verbosity) && $verbosity == 0 );

# Print regular messages to STDOUT, error message ( $verb = -1 ) to STDERR and append "ERROR: " to it to make it clear that this
    # the message is more than just informational or a warning
    my $extra = '';
    my $fh    = *STDOUT;
    if ( $verb < 0 ) {
        $errcnt++;
        $extra = 'ERROR: ';
        $fh    = *STDERR;
    }
    if ( $extra || ( defined($verbosity) && $verb <= $verbosity ) ) {    # Always report Big Errors
        print $fh "${xinfo}${extra}${msg}\n";
    }
    return;
}

# Logger from Cpanel::DAV::CaldavCarddav to handle direct 1:1 copies of the functions we use from there
sub dbg {
    my ( $pkg, $file, $line, $sub, $hasargs ) = caller();
    my @args = @_;

if ( $verbosity >= 4 ) {
        $file =~ s/^\/usr\/local\/cpanel\///;

print '[' . $$ . '] [' . scalar( localtime( time() ) ) . "] [$file : $line ]: ";
        foreach my $what (@args) {
            my $ref = ref $what;
            my $nl  = '\n';
            if ( $ref eq 'HASH' ) {
                print "(ref=$ref)\n" . Dumper($what);
            }
            else {
                print Dumper($what);
            }
        }
    }
    return;
}

# Loads the UID > username mapping into a hash ref. We use this data for translating CCS style URL requests to the native format.
sub load_uid_mapping {
    my ($path) = @_;
    logmsg( 5, "Loading UID mapping from $path" );
    my %map;
    if ( open( my $fh, '<', $path ) ) {
        while (<$fh>) {
            my ( $uid, $user ) = split( /\s+/, $_ );
            $map{$uid} = $user;
        }
    }
    else {
        logmsg( 5, "Could not load UID mapping from $path: $!" );
    }
    return \%map;
}

# Same function as used in a few other scripts to drop privs if requested user is not root
sub _drop_privs_if_needed {
    my ($user) = @_;
    if ( $> == 0 && $user ne 'root' ) {
        require Cpanel::AccessIds::ReducedPrivileges;
        return Cpanel::AccessIds::ReducedPrivileges->new($user);
    }
    return;
}

__END__

=head1 NAME

scripts/migrate_ccs_to_cpdavd

=head1 SYNOPSIS

Usage:

/usr/local/cpanel/scripts/migrate_ccs_to_cpdavd <options>

Examples:

/usr/local/cpanel/scripts/migrate_ccs_to_cpdavd --verbosity=0 --overwrite
    /usr/local/cpanel/scripts/migrate_ccs_to_cpdavd --verbosity=6 --overwrite --user=hibdraco
    /usr/local/cpanel/scripts/migrate_ccs_to_cpdavd --verbosity=3 --dryrun

This script migrates user data from the Calendaring and Contacts plugin to native CPDAVD caldav/carddav.
This requires the CCS Postgres database server to be running.

Available Options:

--help: You are here.
    --verbosity=#: The default is --verbosity=1 . The higher the number, the more debugging output you get.
    --overwrite: Overwrite any existing files. The default is to not overwrite events.
    --dryrun: Do a dry run of the script. This will not write any changes to the filesystem.
    --user=$user: Only process migration for a single account. If this is a system user account, it will process all of the email accounts under it.
      If the user is an email address, it will only process events for that single user.
      Note that this option prevents saving homeless entries, UID mapping for other users, etc and should only be used for debugging or recovery.

=cut

cmd: