Legacy Module Removal - Revision history

SarahK: /* Handling a Failed Removal */

2022-11-01T20:01:55Z

‎Handling a Failed Removal

Lawrence: /* Deletion & Notification Process */

2020-12-15T13:24:33Z

‎Deletion & Notification Process

Lawrence at 13:23, 15 December 2020

2020-12-15T13:23:08Z

Lawrence: /* Deletion & Notification Process */

2020-12-15T13:12:23Z

‎Deletion & Notification Process

Lawrence: /* Deletion & Notification Process */

2020-12-15T13:10:31Z

‎Deletion & Notification Process

Lawrence at 13:03, 18 November 2020

2020-11-18T13:03:49Z

Lawrence: /* Deletion & Notification Process */

2020-11-18T13:02:41Z

‎Deletion & Notification Process

John at 16:08, 13 May 2019

2019-05-13T16:08:22Z

Nathan at 15:34, 21 June 2018

2018-06-21T15:34:37Z

Matt at 15:09, 8 June 2018

2018-06-08T15:09:25Z

← Older revision		Revision as of 20:01, 1 November 2022
Line 26:		Line 26:

	==Handling a Failed Removal==		==Handling a Failed Removal==
−	~~Should a module be unable~~ to ~~be removed~~, the ~~first step would be~~ to ~~determine why that occurred~~. ~~If i was~~ due to the module being in use, ~~deactivating and deleting it may be necessary~~. The ~~process of doing~~ this depends on the type of module ~~in question~~. For ~~example~~: ~~for~~ a ~~provisioning module, any servers and products set~~ to ~~it would need~~ to ~~be changed to a different module, and then the module could be manually deleted from the /~~modules~~/servers folder. If there's any doubt, it is best to contact the author of the module for assistance with the removal process~~.	+
		+	If removal fails, you will see the following message in an email notification or in the '''Activity Log''' at '''Configuration (<i class="fa fa-wrench"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Activity Log''':
		+
		+	<div class="source-cli">
		+	A recent WHMCS update failed to remove legacy modules. These modules may cause
		+	<br/>negative behavior if you upgrade PHP and leave them on the system.
		+	<br/><br/>We recommend working to remove them manually.
		+	</div>
		+
		+	This typically occurs due to one of the following reasons:
		+	* The '''Automatic Updater''' utility detected that the module is currently active and configured in WHMCS. Because of this, the system treated the module as being in use.
		+	* The '''Automatic Updater''' utility could not delete the module's files due to permission restrictions.
		+
		+	If this occurs, you will need to remove the affected modules manually. The method to do this depends on the type of module. For more information, see [https://help.whmcs.com/m/updating/l/850628-troubleshooting-a-failed-to-remove-legacy-modules-error Troubleshooting A Failed to remove legacy modules Error].

@@ Line 14: / Line 14: @@
 # A legacy module is found to be unused and is successfully deleted. A log entry starting with "Unused legacy modules were deleted" will be created, and will contain a comma separated list of the modules that were deleted. An email message will be sent to notify system administrators of the modules that were deleted.
 # A legacy module is found to be in use and is not attempted for deletion. A log entry starting with "One or more legacy modules were found to be in use and were not attempted to be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted. An email message will be sent to notify system administrators of this condition.
-# A legacy module is found to be unused and deletion is attempted, but the deletion fails (e.g. due to insufficient permissions or a filesystem issue). A log entry starting with "One or more legacy modules could not be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted will be created. An email message will be sent to notify system administrators of this condition.
+# A legacy module is found to be unused and deletion is attempted, but the deletion fails (e.g. due to insufficient permissions or a filesystem issue). A log entry starting with "One or more legacy modules could not be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted. An email message will be sent to notify system administrators of this condition.
 == Handling Notifications ==

← Older revision		Revision as of 13:23, 15 December 2020
Line 24:		Line 24:

	Once all modules in the received email have been addressed, either by manual deletion or by contacting the module author, then we would recommend using the [[PHP_Version_Compatibility_Assessment\|PHP Version Compatibility Assessment utility]] to help locate any other files that may negatively affect WHMCS.		Once all modules in the received email have been addressed, either by manual deletion or by contacting the module author, then we would recommend using the [[PHP_Version_Compatibility_Assessment\|PHP Version Compatibility Assessment utility]] to help locate any other files that may negatively affect WHMCS.
		+
		+	==Handling a Failed Removal==
		+	Should a module be unable to be removed, the first step would be to determine why that occurred. If i was due to the module being in use, deactivating and deleting it may be necessary. The process of doing this depends on the type of module in question. For example: for a provisioning module, any servers and products set to it would need to be changed to a different module, and then the module could be manually deleted from the /modules/servers folder. If there's any doubt, it is best to contact the author of the module for assistance with the removal process.

@@ Line 13: / Line 13: @@
 # A legacy module is found to be unused and is successfully deleted. A log entry starting with "Unused legacy modules were deleted" will be created, and will contain a comma separated list of the modules that were deleted. An email message will be sent to notify system administrators of the modules that were deleted.
-# A legacy module is found to be in use and is not attempted for deletion. A log entry starting with "One or more legacy modules could not be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted. An email message will be sent to notify system administrators of this condition.
+# A legacy module is found to be in use and is not attempted for deletion. A log entry starting with "One or more legacy modules were found to be in use and were not attempted to be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted. An email message will be sent to notify system administrators of this condition.
-# A legacy module is found to be unused and deletion is attempted, but the deletion fails (e.g. due to insufficient permissions or a filesystem issue). A log entry will be created. An email message will be sent to notify system administrators of this condition.
+# A legacy module is found to be unused and deletion is attempted, but the deletion fails (e.g. due to insufficient permissions or a filesystem issue). A log entry starting with "One or more legacy modules could not be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted will be created. An email message will be sent to notify system administrators of this condition.
 == Handling Notifications ==

@@ Line 12: / Line 12: @@
 Following the inspection WHMCS will attempt to perform outdated module deletion. There may be three possible outcomes:
-# A legacy module is found to be unused and is successfully deleted. A log entry will be created. An email message will be sent to notify system administrators of the modules that were deleted.
+# A legacy module is found to be unused and is successfully deleted. A log entry starting with "Unused legacy modules were deleted" will be created, and will contain a comma separated list of the modules that were deleted. An email message will be sent to notify system administrators of the modules that were deleted.
-# A legacy module is found to be in use and is not attempted for deletion. A log entry will be created. An email message will be sent to notify system administrators of this condition.
+# A legacy module is found to be in use and is not attempted for deletion. A log entry starting with "One or more legacy modules could not be deleted" will be created, and will contain a comma separated list of the modules that were unable to be deleted. An email message will be sent to notify system administrators of this condition.
 # A legacy module is found to be unused and deletion is attempted, but the deletion fails (e.g. due to insufficient permissions or a filesystem issue). A log entry will be created. An email message will be sent to notify system administrators of this condition.

@@ Line 2: / Line 2: @@
 <div class="docs-alert-warning"><i class="fa fa-exclamation-circle"></i> If you were directed to this page via an email notification, then please refer to the [[#Handling Notifications|Handling Notifications]] section.</div>
-Old PHP code may introduce breakage on newer versions of PHP runtime. In order to protect your system from unexpected downtime, WHMCS 7.5 will perform an inspection for any unused legacy modules. Legacy modules are modules that are no longer maintained or distributed and are typically for older and often discontinued services.
+Old PHP code may introduce breakage on newer versions of PHP runtime. In order to protect your system from unexpected downtime, WHMCS 7.5 and newer will perform an inspection for any unused legacy modules. Legacy modules are modules that are no longer maintained or distributed and are typically for older and often discontinued services.
 __TOC__

@@ Line 1: / Line 1: @@
 <div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.5 and above.</div>
-<div class="docs-alert-warning"><i class="fa fa-exclamation-circle"></i> If you were directed to this page via an email notification, then please refer to the [[Legacy_Module_Removal:Handling Notifications|Handling Notifications]] section.</div>
+<div class="docs-alert-warning"><i class="fa fa-exclamation-circle"></i> If you were directed to this page via an email notification, then please refer to the [[#Handling Notifications|Handling Notifications]] section.</div>
 Old PHP code may introduce breakage on newer versions of PHP runtime. In order to protect your system from unexpected downtime, WHMCS 7.5 will perform an inspection for any unused legacy modules. Legacy modules are modules that are no longer maintained or distributed and are typically for older and often discontinued services.

← Older revision		Revision as of 15:34, 21 June 2018
Line 1:		Line 1:
−	<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.5 and above</div>	+	<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.5 and above.</div>
	<div class="docs-alert-warning"><i class="fa fa-exclamation-circle"></i> If you were directed to this page via an email notification, then please refer to the [[Legacy_Module_Removal:Handling Notifications\|Handling Notifications]] section.</div>		<div class="docs-alert-warning"><i class="fa fa-exclamation-circle"></i> If you were directed to this page via an email notification, then please refer to the [[Legacy_Module_Removal:Handling Notifications\|Handling Notifications]] section.</div>

@@ Line 7: / Line 7: @@
 == Inspection Process ==
-During the inspection WHMCS will check for the following modules:
+During updates, WHMCS will check for modules that are no longer officially maintained or supported.  If a module is activated and configured then that module will be considered to be in use, and WHMCS will not attempt to delete that module.
 == Deletion & Notification Process ==