[meta] Convert all variables to state and/or config systems [#1775842]

Posted by heyrocker on September 5, 2012 at 10:50pm

60 followers

Issue Summary

We want to get rid of the variables system, and in order to do that we need to deal with all the variables in core. Most of these will be converted to either the new configuration system (much of this being tracked in #1696224: Remove system_settings_form()) and most of what is left will be moved to the new state system one it lands (#1175054: Add a storage (API) for persistent non-configuration state). This issue is here to track the conversion of these variables.

The good news: As of the creation of this issue, CMI had converted 81 variables.
The bad news: As of the creation of this issue, there are 232 variables left. 52 of these have issues created to deal with them and 180 remain.

This list was originally generated by cosmicdreams in a google doc. I have taken that list, removed the variables converted by CMI as well as some invalid ones, and exported it to HTML with some minimal cleanup. There is probably still some garbage here, but I think it is a useful start.

How tos

Todo (26)

Variable name	File found in	Issue
drupal_js_version_query_string	common.inc	#1824848: Convert drupal_js_version_query_string to the state system
css_js_query_string	common.inc	#1798738: Move css_js_query_string to state system
file_public_path	file.inc	#1856766: Convert file_public_path to the new settings system (make it not configurable via UI or YAML)
install_current_batch	install.core.inc	#1798732: Split installer into pre-storage & storage-exists phases, and convert the install_task variable to use the state system
install_profile	common.inc	#1827112: Convert 'install_profile' variable to Configuration system
install_task	shortcut.install	#1798732: Split installer into pre-storage & storage-exists phases, and convert the install_task variable to use the state system
install_time	system.module	#1798732: Split installer into pre-storage & storage-exists phases, and convert the install_task variable to use the state system
language_content_type_ . % (locale_uninstall)	local.install	#1827038: Convert language variables to cmi
language_count	bootstrap.inc	#1856976: Convert language_count to the state system.
language_default	bootstrap.inc	#1827038: Convert language variables to cmi
language_types	bootstrap.inc	#1827038: Convert language variables to cmi
locale_translate_english	locale.module	#1998088: Convert locale_translate_english variable to CMI
locale_custom_strings_*	settings.php	#1975490: Convert locale_custom_strings_* to settings
maintenance_theme	theme.maintenance.inc	#1829170: Convert the Maintenance Theme variable to settings
node_admin_theme	book.module	#1779486: Convert Node module variables/settings into configuration
node_options_ . $type	content_types.inc	#111715: Convert node/content types into configuration
node_preview_ . $type	content_types.inc	#111715: Convert node/content types into configuration
node_rank_ . $rank		#1831632: Convert node_rank_ $rank variables to use configuration system
node_submitted_ . $type	content_types.inc	#111715: Convert node/content types into configuration
page_cache_invoke_hooks	bootstrap.inc	#1576322: page_cache_without_database doesn't return cached pages without the database
taxonomy_ . $vid . _synonyms	taxonomy.module	#1831540: Rewrite examples in taxonomy.api.php and remove references to synonyms
menu_default_node_menu	views\lib\Drupal\views\Plugin\views\display\Page.php	#1975114: Views references menu_default_node_menu variable which doesn't exist anywhere else
node_type_language_translation_enabled_ . $type	translation.module	#1952062: Remove legacy translation module in favor of content translation
comment_*	comment.module	#731724: Decouple comment.module from node by turning comment settings into a field

Completed (136)

Variable name	File found in	Issue
session_write_interval	session.inc	#1969846: Convert session_write_interval to settings
field_storage_default		#1942346: Convert Field API variables to CMI
mymodule_shortcut_admin_default_set	shortcut.api.php	#1975150: Remove variable_get from mymodule_shortcut_admin_default_set in the shortcut.api.php
theme_$theme_settings	theme.inc	#1712250: Convert theme settings to configuration system / #1830978: Convert theme setting variables in system module to CMI
theme_settings	theme.inc	#1712250: Convert theme settings to configuration system / #1830978: Convert theme setting variables in system module to CMI
node_test_change_view_mode	node_test.module	#1937212: Change node test variables 'node_test_change_view_mode' and 'node_access_test_secret_catalan' to the state system
node_access_test_secret_catalan	node_access_test.module	#1937212: Change node test variables 'node_test_change_view_mode' and 'node_access_test_secret_catalan' to the state system
drupal_css_cache_files	ColorTest	#1937270: Change drupal_css_cache_files into state.
https	common.inc	#1798832: Convert https to $settings
image_toolkit	system.admin.inc	#1937196: Convert image_toolkit to cmi
image_jpeg_quality	image.gd.inc	#1937140: Convert image_jpeg_quality to cmi
site_name	user\lib\Drupal\user\Tests\UserPasswordResetTest.php	#1932596: Change site_name into config in userpasswordreset.test and formtest
path_alias_whitelist	path.inc	#1798884: Convert path_alias_whitelist to state system
locale_translation_plurals	gettext.inc	#1751348: Convert locale settings to configuration system
color_ . $theme . _files	color.module	#1804380: convert color variables to config/state
color_ . $theme . _palette	color.module	#1804380: convert color variables to config/state
color_ . $theme_key . _logo	color.module	#1804380: convert color variables to config/state
color_ . $theme_key . _stylesheets	color.module	#1804380: convert color variables to config/state
file_chmod_directory	file.inc	#1496480: Convert file system settings to the new configuration system
file_chmod_file	file.inc	#1496480: Convert file system settings to the new configuration system
file_default_scheme	file.inc	#1496480: Convert file system settings to the new configuration system
file_private_path	file.inc	#1496480: Convert file system settings to the new configuration system
file_temporary_path	file.inc	#1496480: Convert file system settings to the new configuration system
autoloader_mode	bootstrap.inc	#1814086: Convert autoloader_mode in drupal_classloader to its own global
404_fast_html	bootstrap.inc	#1778478: Convert fast_404 to CMI
404_fast_paths	bootstrap.inc	#1778478: Convert fast_404 to CMI
404_fast_paths_exclude	bootstrap.inc	#1778478: Convert fast_404 to CMI
simpletest_bootstrap_variable_test	bootstrap.test	Do not convert
actions_max_stack	actions.inc	#1788084: Convert actions variable(s) to CMI - add upgrade path
admin_compact_mode	system.module	#1824762: Convert admin_compact_mode to CMI
admin_theme	theme.inc	#1798872: Convert admin_theme to CMI
allow_authorize_operations	authorize.php	#1804346: Convert authorize variables to config system.
allow_authorize_operations	update.module	#1804346: Convert authorize variables to config system.
authorize_filetransfer_connection_settings_ . $backend	authorize.inc	#1804346: Convert authorize variables to config system.
authorize_filetransfer_default	authorize.inc	#1804346: Convert authorize variables to config system.
ban_ips	ban.module	#1479466: Convert IP address blocking to config system (setting was removed)
batch_test_stack	batch_test.module	#1843410: Change variable batch_test_stack to the state system.
block_test_*	block_test.module	#1843420: Change block test variables - block_test_cache and block_test_content to state system
cache_backends	bootstrap.inc	#1823396: Convert cache_backends to cmi (cannot be cmi or state, already not using variable_get() anymore)
configurable_timezone	system.admin.inc	#1571632: Convert regional settings to configuration system
common_test_cron	system.test	#1790920: Move cron_last, node_cron_last and common_test_cron to state system
cron_last	system.admin.inc	#1790920: Move cron_last, node_cron_last and common_test_cron to state system
css_gzip_compression	common.inc	#1824778: Convert css_gzip_compression and js_gzip_compression variables to CMI system
default_nodes_main		#1824834: Covert default_nodes_main variable to CMI system
dependency_test	module_test.module	#1843452: Change dependency_test variable to state system.
drupal_private_key	common.inc	#1798734: Convert drupal_private_key to the configuration system.
drupal_js_cache_files	common.inc	#1798724: Convert drupal_js_cache_files to State system
drupal_stale_file_threshold	common.inc	#1824854: Convert variable drupal_stale_file_threshold to CMI system
drupal_test_email_collector	VariableLog.php	#1824768: Convert drupal_test_email_collector variable to CMI system
drupal_weight_select_max	form.inc	#1824898: Convert drupal_weight_select_max variable to CMI system
entity_cache_test	entity.test	#1843462: Change entity_test variables - entity_test_translation, entity_cache_test and entity_cache_test_label to the state system.
entity_cache_test_label	entity_cache_test_dependency.module	#1843462: Change entity_test variables - entity_test_translation, entity_cache_test and entity_cache_test_label to the state system.
entity_form_langcode	some tests	#1932806: Change entity_form_langcode to the state system.
entity_test_translation	entity_test.module	#1843462: Change entity_test variables - entity_test_translation, entity_cache_test and entity_cache_test_label to the state system.
error_level	error.inc	#1798756: Finish conversion of error_level to CMI
field_purge_batch_size	field.module	#1798782: Convert field_purge_batch_size to CMI
field_test_*	field_test.entity.inc	#1843476: Change field_test variables to state system.
file_description_length	file.field.inc	#1804394: convert file.module variables to CMI
file_description_type	file.field.inc	#1804394: convert file.module variables to CMI
file_icon_directory	file.field.inc	#1804394: convert file.module variables to CMI
file_test_*	file_test.module	#1843486: Change file_test variables to state system.
filter_allowed_protocols	common.inc	#1799440: Convert Filter variables to Configuration System
filter_default_format		#1799440: Convert Filter variables to Configuration System
filter_fallback_format	filter.module	#1799440: Convert Filter variables to Configuration System
front_page_output	system_test.module	#1848058: Change system test variables to the state system
image_module_test_file_download	image_module_text.module	#1824926: Convert image_module_test_file_download variable to CMI system
image_style_preview_image	image.admin.inc	#1828924: Convert the Image Style Preview Image to CMI
image_test_results	image_test.module	#1848058: Change system test variables to the state system
install_profile_modules	install.core.inc	#1830148: Convert 'install_profile_modules' variable to state
javascript_parsed	locale.module	#1798796: Convert javascript_parsed variable to use state system
js_gzip_compression	common.inc	#1824778: Convert css_gzip_compression and js_gzip_compression variables to CMI system
language_negotiation_ . $type	language.inc	#1714462: Convert language negotiation settings to configuration system
language_negotiation_methods_weight_$type	language.negotiation.inc	#1714462: Convert language negotiation settings to configuration system
language_test_*	language_test.module	#1843948: Change language test variables to the state system.
lock_backend	lock.inc	#1825450: Use lock service in lock()
mac_key	OpenIDFunctionalTest.php	#1826190: Remove dead mac_key variable from open_id_test module
mail_line_endings	PhpMail.php	#1821420: Convert mail variables to cmi
mail_system	mail.inc	#1821420: Convert mail variables to cmi
maximum_replication_lag	database.inc	#1833516: Add a new top-level global for settings.php - move things out of $conf
menu_default_active_menus	menu.inc	#1829308: Convert variables in menu.inc to config and state
menu_inc	common.inc	#1833516: Add a new top-level global for settings.php - move things out of $conf
menu_expanded	menu.inc	#1829308: Convert variables in menu.inc to config and state
menu_override_parent_selector	book.module	#1830936: Convert the 'menu_override_parent_selector' variable to CMI
menu_test_*	menu.test	#1843954: Change menu test variables to the state system.
node_access_needs_rebuild	node.module	#1798804: Convert node_access_needs_rebuild to state system
node_access_test_private	node_access_test module	#1814402: Convert 'node_access_test_private' variable to state() system
node_cron_comments_scale	comment.module	#1831486: Convert comment variables to config/state
node_cron_last		#1790920: Move cron_last, node_cron_last and common_test_cron to state system
node_cron_views_scale	statistics.module	#1831522: Convert statistics variables to config/state
node_recent_block_count	node.module	#1798852: Convert node_recent_block_count to use state system (unnecessary - will be part of Scotch initiative)
node_test_node_access_all_uid		#1798868: Convert node_test_node_access_all_uid to state system
node_type_language_ . $type	content_types.inc	#1739928: Generalize language configuration on content types to apply to terms and other entities
openid_test_*	openid_test.module	#1848054: Change openid test variables to the state system.
omit_vary_cookie	bootstrap.inc	#1831076: Convert omit_vary_cookie to cmi
path_inc	common.inc	#1269742: Make path lookup code into a pluggable class
password_count_log2	password.inc	#1463624: Move password.inc into DIC
password_inc	system.test	#1463624: Move password.inc into DIC
path_test_results	path.test	#1848058: Change system test variables to the state system
sample_search_force_keywords	search.api.inc	#1496510: Convert search settings to configuration system
session_inc	bootstrap.inc	#1833516: Add a new top-level global for settings.php - move things out of $conf
statistics_day_timestamp	statistics.module	#1831522: Convert statistics variables to config/state
syslog_facility	syslog.module	#1804408: convert syslog variables to config/state system.
syslog_format	syslog.module	#1804408: convert syslog variables to config/state system.
syslog_identity	syslog.module	#1804408: convert syslog variables to config/state system.
shortcut_max_slots	shortcut.admin.inc	#682000: Remove the default limit of 7 shortcuts per shortcut set
taxonomy_maintain_index_table	taxonomy.module	#1799218: Convert taxonomy_override_selector and taxonomy_terms_per_page_admin variables to use configuration system
taxonomy_override_selector	taxonomy.admin.inc	#1799218: Convert taxonomy_override_selector and taxonomy_terms_per_page_admin variables to use configuration system
taxonomy_terms_per_page_admin	taxonomy.admin.inc	#1799218: Convert taxonomy_override_selector and taxonomy_terms_per_page_admin variables to use configuration system
teaser_length	text.module	#1798880: Convert teaser_length to use configuration system
test_module_disable_order	module_test.test	#1872834: Convert test_module_disable_order and test_module_uninstall_order to the new configuration system
test_module_enable_order	system.test	#1848058: Change system test variables to the state system
test_module_uninstall_order	module_test.test	#1872834: Convert test_module_disable_order and test_module_uninstall_order to the new configuration system
test_verbose_module_hooks	system_test.module	#1848058: Change system test variables to the state system
theme_default	theme.inc	#1829224: Convert the 'theme_default' variable to CMI
theme_link	common.inc	#1824920: Convert variable 'theme_link' to config system
tracker_index_nid	Tracker module	#1813184: Convert variable 'tracker_index_nid' to state system
translation_language_type	translation.pages.inc	#1830848: Convert the 'translation_language_type' variable to CMI
update_d8_requirements	update.inc	#1831822: convert update variables to state
update_last_check	update.manager.inc	#1810880: Convert update_last_check and update_last_email_notification variables to CMI system
update_last_email_notification	update.fetch.inc	#1810880: Convert update_last_check and update_last_email_notification variables to CMI system
user_block_max_list_count	user.module	#1823348: Convert user_block variables to cmi
user_block_seconds_online	user.module	#1823348: Convert user_block variables to cmi
user_block_whois_new_count	user.module	#1823348: Convert user_block variables to cmi
user_cancel_method	user.pages.inc	#1807266: Convert user_cancel_method variable to CMI system
user_mail_ . $key	user.module	#1757566: Convert user account e-mail templates to configuration system
user_password_reset_timeout	user.pages.inc	#1814558: Convert user_password_reset_timeout variable to use config system
user_picture_default	user.admin.inc	#1292470: Convert user pictures to Image Field
user_picture_dimensions	user.admin.inc	#1292470: Convert user pictures to Image Field
user_picture_file_size	user.admin.inc	#1292470: Convert user pictures to Image Field
user_picture_guidelines	user.admin.inc	#1292470: Convert user pictures to Image Field
user_picture_path	user.admin.inc	#1292470: Convert user pictures to Image Field
user_picture_style	user.admin.inc	#1292470: Convert user pictures to Image Field
user_pictures	system.admin.inc	#1292470: Convert user pictures to Image Field
xmlrpc_test_xmlrpc_alter	xmlrpc_test.module	#1848066: Change variable xmlrpc_test_xmlrpc_alter to the state system.
xri_proxy_resolver	openid.module	#1824712: Convert xri_proxy_resolver variable to CMI config system
queue_class_ . $name	common.inc	#1814496: Make queue a container service
queue_default_class	common.inc	#1814496: Make queue a container service
queue_default_reliable_class	common.inc	#1814496: Make queue a container service
register_pending_approval_admin	user.module	#1804926: Convert register_pending_approval_admin email to config system and provide the ability to configure it in UI.

Comments

#1

Posted by heyrocker on September 5, 2012 at 10:53pm

Attachment	Size	Status	Test result	Operations
my_tombstone.jpg	37.25 KB	Ignored: Check issue status.	None	None

#2

Posted by heyrocker on September 5, 2012 at 10:59pm

Priority:

normal

» critical

#3

Posted by sun on September 5, 2012 at 11:49pm

Fixing the utterly ugly styling. (by implanting some sensible CSS)

#4

Posted by Mile23 on September 6, 2012 at 1:21am

What's the best place to read to find out how to do this conversion?

#5

Posted by heyrocker on September 6, 2012 at 3:05am

For the moment, we're a little blocked on #1175054: Add a storage (API) for persistent non-configuration state. All the obvious variables tied to configuration have issues already, and the issues that remain are pretty complicated. However, once the state system lands, we will need a plan of attack. For config, we split the issues out based on the forms the variables appeared in. I'm not sure what the best way to split this one out is. By the file the variables appear in? Anyone have other ideas?

#6

Posted by HongPong on September 6, 2012 at 7:13pm

@mile23 here is a pretty good guide for how to do this: http://drupal.org/node/1667896 . Also this is very helpful: http://heyrocker.com/how-use-drupal-8-configuration-system

#7

Posted by cosmicdreams on September 6, 2012 at 7:16pm

Oh we have an issue for this awesome!

#8

Posted by heyrocker on September 6, 2012 at 7:48pm

@Hongpong note that most of the remaining variables to be converted are not configuration at all, but will be moving to the new state system (#1175054: Add a storage (API) for persistent non-configuration state)

#9

Posted by heyrocker on September 7, 2012 at 1:52am

I cleaned this list up a bit, it now lists all the issues covering variable conversion at the top, and the table is just the variables that remain unclaimed. This makes a little more sense since these issues all cover a variety of different variables.

#10

Posted by heyrocker on September 7, 2012 at 1:53am

#11

Posted by webchick on September 7, 2012 at 5:29am

Please don't forget to update settings.php $conf override examples as you go through: #1716920: $conf override example documentation needs updating

#13

Posted by Mile23 on September 8, 2012 at 5:08pm

@HongPong thanks!

Maybe someone with superpowers can add those links to the original issue.

#14

Posted by webchick on September 15, 2012 at 4:02am

Also created #1785338: Create a change notice containing table of old vs. new variable names. Maybe this table could be created as we go to make it easier?

#15

Posted by heyrocker on September 15, 2012 at 4:06am

Well we already converted a bunch so it can already get started.

#16

Posted by catch on September 17, 2012 at 10:22am

Hmm we have

http://api.drupal.org/api/drupal/core!includes!update.inc/function/update_variables_to_config/8

What if we required the variable map to be stored somewhere parseable (like make it a class?), then it could be used to generate lists, for coder module etc.

#17

Posted by xjm on October 4, 2012 at 1:51am

We filed #1802750: [Meta] Convert configurable data to ConfigEntity system as a meta for data that should use the ConfigEntity system. I updated the summary.

See #1668820: Concept, base class, and interface for Configurables (e.g., node types, image styles, vocabularies, views, etc) for an explanation of what Configurables are (as compared to plain configuration or state).

#18

Posted by heyrocker on January 7, 2013 at 10:05pm

A little status update on this progress. There are currently 288 calls to variable_get() left in core. Of these...

51 are for 'theme_default'
50 are for file_*
30 are for locale_*

The rest are scattered around, although quite a few of those are destined to be fixed around #1833516: Add a new top-level global for settings.php - move things out of $conf and those should be reasonably easy.

So we're moving along really well. Keep up the great work everyone!

#19

Posted by catch on January 14, 2013 at 10:29pm

Status:

active

» needs work

Just getting ready.

Attachment	Size	Status	Test result	Operations
die.patch	4.71 KB	Ignored: Check issue status.	None	None

Project:	Drupal core
Version:	8.x-dev
Component:	base system
Category:	task
Priority:	critical
Assigned:	Unassigned
Status:	needs work
Issue tags:	Configuration system, State system, Variable tombstone

[meta] Convert all variables to state and/or config systems

Jump to:

Issue Summary

How tos

Todo (26)

Completed (136)

Comments

#1

#2

#3

#4

#5

#6

#7

#8

#9

#10

#11

#13

#14

#15

#16

#17

#18

#19

#20

#21

#22

#23