diff options
Diffstat (limited to 'user_guide_src/source/installation')
| -rw-r--r-- | user_guide_src/source/installation/index.rst | 9 | ||||
| -rw-r--r-- | user_guide_src/source/installation/upgrade_200.rst | 3 | ||||
| -rw-r--r-- | user_guide_src/source/installation/upgrade_220.rst | 21 | ||||
| -rw-r--r-- | user_guide_src/source/installation/upgrade_300.rst | 76 | ||||
| -rw-r--r-- | user_guide_src/source/installation/upgrading.rst | 60 |
5 files changed, 122 insertions, 47 deletions
diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst index 7f75f7867..50493bbbd 100644 --- a/user_guide_src/source/installation/index.rst +++ b/user_guide_src/source/installation/index.rst @@ -47,8 +47,11 @@ Started <../overview/getting_started>` section of the User Guide to begin learning how to build dynamic PHP applications. Enjoy! .. toctree:: - :glob: :hidden: :titlesonly: - - *
\ No newline at end of file + + downloads + self + upgrading + troubleshooting + diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst index 948b1bc58..ca2c6c1e0 100644 --- a/user_guide_src/source/installation/upgrade_200.rst +++ b/user_guide_src/source/installation/upgrade_200.rst @@ -109,7 +109,6 @@ Please refer to the :ref:`2.0.0 Change Log <2.0.0-changelog>` for full details, but here are some of the larger changes that are more likely to impact your code: -- CodeIgniter now requires PHP 5.2.4. - Scaffolding has been removed. - The CAPTCHA plugin in now a :doc:`helper </helpers/captcha_helper>`. - The JavaScript calendar plugin was removed. @@ -146,4 +145,4 @@ The following files have been changed: The following files have been added: - foreign_chars.php -- profiler.php +- profiler.php
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_220.rst b/user_guide_src/source/installation/upgrade_220.rst new file mode 100644 index 000000000..beb7bd7d7 --- /dev/null +++ b/user_guide_src/source/installation/upgrade_220.rst @@ -0,0 +1,21 @@ +############################# +Upgrading from 2.1.4 to 2.2.0 +############################# + +.. note:: The :doc:`Encrypt Class <libraries/encrypt>` now requires the + Mcrypt extension. If you were previously using the Encrypt Class + without Mcrypt, then this is a breaking change. You must install + the Mcrypt extension in order to upgrade. For information on + installing Mcrypt please see the PHP `documentation + <http://php.net/manual/en/mcrypt.setup.php>`. + +Before performing an update you should take your site offline by +replacing the index.php file with a static one. + +Step 1: Update your CodeIgniter files +===================================== + +Replace all files and directories in your "system" folder. + +.. note:: If you have any custom developed files in these folders please + make copies of them first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst index 81340e6ad..c84d16b31 100644 --- a/user_guide_src/source/installation/upgrade_300.rst +++ b/user_guide_src/source/installation/upgrade_300.rst @@ -1,5 +1,5 @@ ############################# -Upgrading from 2.1.4 to 3.0.0 +Upgrading from 2.2.0 to 3.0.0 ############################# .. note:: These upgrade notes are for a version that is yet to be released. @@ -223,8 +223,45 @@ Otherwise however, please review your usage of the following functions: ``$_COOKIE`` and ``$_SERVER`` superglobals are no longer automatically overwritten when global XSS filtering is turned on. +************************************************* +Step 12: Check for potential XSS issues with URIs +************************************************* + +The :doc:`URI Library <../libraries/uri>` used to automatically convert +a certain set of "programmatic characters" to HTML entities when they +are encountered in a URI segment. + +This was aimed at providing some automatic XSS protection, in addition +to the ``$config['permitted_uri_chars']`` setting, but has proven to be +problematic and is now removed in CodeIgniter 3.0. + +If your application has relied on this feature, you should update it to +filter URI segments through ``$this->security->xss_clean()`` whenever you +output them. + +**************************************************************** +Step 13: Check for usage of the 'xss_clean' Form validation rule +**************************************************************** + +A largely unknown rule about XSS cleaning is that it should *only be +applied to output*, as opposed to input data. + +We've made that mistake ourselves with our automatic and global XSS cleaning +feature (see previous step about XSS above), so now in an effort to discourage that +practice, we're also removing 'xss_clean' from the officially supported +list of :doc:`form validation <../libraries/form_validation>` rules. + +Because the :doc:`Form Validation library <../libraries/form_validation>` +generally validates *input* data, the 'xss_clean' rule simply doesn't +belong in it. + +If you really, really need to apply that rule, you should now also load the +:doc:`Security Helper <../helpers/security_helper>`, which contains +``xss_clean()`` as a regular function and therefore can be also used as +a validation rule. + ******************************************************** -Step 12: Update usage of Input Class's get_post() method +Step 14: Update usage of Input Class's get_post() method ******************************************************** Previously, the :doc:`Input Class <../libraries/input>` method ``get_post()`` @@ -234,15 +271,15 @@ modified so that it searches in GET then in POST, as its name suggests. A method has been added, ``post_get()``, which searches in POST then in GET, as ``get_post()`` was doing before. -*********************************************************************** -Step 13: Update usage of Directory Helper's directory_map() function -*********************************************************************** +******************************************************************** +Step 15: Update usage of Directory Helper's directory_map() function +******************************************************************** In the resulting array, directories now end with a trailing directory separator (i.e. a slash, usually). ************************************************************* -Step 14: Update usage of Database Forge's drop_table() method +Step 16: Update usage of Database Forge's drop_table() method ************************************************************* Up until now, ``drop_table()`` added an IF EXISTS clause by default or it didn't work @@ -264,7 +301,7 @@ If your application relies on IF EXISTS, you'll have to change its usage. all drivers with the exception of ODBC. *********************************************************** -Step 15: Change usage of Email library with multiple emails +Step 17: Change usage of Email library with multiple emails *********************************************************** The :doc:`Email Library <../libraries/email>` will automatically clear the @@ -279,7 +316,7 @@ pass FALSE as the first parameter in the ``send()`` method: } *************************************************** -Step 16: Update your Form_validation language lines +Step 18: Update your Form_validation language lines *************************************************** Two improvements have been made to the :doc:`Form Validation Library @@ -310,7 +347,7 @@ files and error messages format: later. **************************************************************** -Step 17: Remove usage of (previously) deprecated functionalities +Step 19: Remove usage of (previously) deprecated functionalities **************************************************************** In addition to the ``$autoload['core']`` configuration setting, there's a @@ -331,11 +368,14 @@ Usage of the ``EXT`` constant has been deprecated since dropping support for PHP longer a need to maintain different filename extensions and in this new CodeIgniter version, the ``EXT`` constant has been removed. Use just '.php' instead. -Smiley helper js_insert_smiley() -================================ +Smiley helper +============= -:doc:`Smiley Helper <../helpers/smiley_helper>` function ``js_insert_smiley()`` has been deprecated -since CodeIgniter 1.7.2 and is now removed. You'll need to switch to ``smiley_js()`` instead. +The :doc:`Smiley Helper <../helpers/smiley_helper>` is a legacy feature from EllisLab's +ExpressionEngine product. However, it is too specific for a general purpose framework like +CodeIgniter and as such it is now deprecated. + +Also, the previously deprecated ``js_insert_smiley()`` (since version 1.7.2) is now removed. The Encrypt library =================== @@ -355,6 +395,16 @@ implemented cryptographic functions. .. important:: You are strongly encouraged to switch to the new :doc:`Encryption Library <../libraries/encryption>` as soon as possible! +The Cart library +================ + +The :doc:`Cart Library <../libraries/cart>`, similarly to the :doc:`Smiley Helper +<../helpers/smiley_helper>` is too specific for CodeIgniter. It is now deprecated +and scheduled for removal in CodeIgniter 3.1+. + +.. note:: The library is still available, but you're strongly encouraged to remove its usage sooner + rather than later. + Database drivers 'mysql', 'sqlite', 'mssql', 'pdo/dblib' ======================================================== diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst index 6d2e788dd..366aa13f7 100644 --- a/user_guide_src/source/installation/upgrading.rst +++ b/user_guide_src/source/installation/upgrading.rst @@ -5,33 +5,35 @@ Upgrading From a Previous Version Please read the upgrade notes corresponding to the version you are upgrading from. -- :doc:`Upgrading from 2.1.4 to 3.0.0 <upgrade_300>` -- :doc:`Upgrading from 2.1.3 to 2.1.4 <upgrade_214>` -- :doc:`Upgrading from 2.1.2 to 2.1.3 <upgrade_213>` -- :doc:`Upgrading from 2.1.1 to 2.1.2 <upgrade_212>` -- :doc:`Upgrading from 2.1.0 to 2.1.1 <upgrade_211>` -- :doc:`Upgrading from 2.0.3 to 2.1.0 <upgrade_210>` -- :doc:`Upgrading from 2.0.2 to 2.0.3 <upgrade_203>` -- :doc:`Upgrading from 2.0.1 to 2.0.2 <upgrade_202>` -- :doc:`Upgrading from 2.0 to 2.0.1 <upgrade_201>` -- :doc:`Upgrading from 1.7.2 to 2.0 <upgrade_200>` -- :doc:`Upgrading from 1.7.1 to 1.7.2 <upgrade_172>` -- :doc:`Upgrading from 1.7.0 to 1.7.1 <upgrade_171>` -- :doc:`Upgrading from 1.6.3 to 1.7.0 <upgrade_170>` -- :doc:`Upgrading from 1.6.2 to 1.6.3 <upgrade_163>` -- :doc:`Upgrading from 1.6.1 to 1.6.2 <upgrade_162>` -- :doc:`Upgrading from 1.6.0 to 1.6.1 <upgrade_161>` -- :doc:`Upgrading from 1.5.4 to 1.6.0 <upgrade_160>` -- :doc:`Upgrading from 1.5.3 to 1.5.4 <upgrade_154>` -- :doc:`Upgrading from 1.5.2 to 1.5.3 <upgrade_153>` -- :doc:`Upgrading from 1.5.0 or 1.5.1 to 1.5.2 <upgrade_152>` -- :doc:`Upgrading from 1.4.1 to 1.5.0 <upgrade_150>` -- :doc:`Upgrading from 1.4.0 to 1.4.1 <upgrade_141>` -- :doc:`Upgrading from 1.3.3 to 1.4.0 <upgrade_140>` -- :doc:`Upgrading from 1.3.2 to 1.3.3 <upgrade_133>` -- :doc:`Upgrading from 1.3.1 to 1.3.2 <upgrade_132>` -- :doc:`Upgrading from 1.3 to 1.3.1 <upgrade_131>` -- :doc:`Upgrading from 1.2 to 1.3 <upgrade_130>` -- :doc:`Upgrading from 1.1 to 1.2 <upgrade_120>` -- :doc:`Upgrading from Beta 1.0 to Beta 1.1 <upgrade_b11>` +.. toctree:: + :titlesonly: + Upgrading from 2.1.4 to 3.0.0 <upgrade_300> + Upgrading from 2.1.3 to 2.1.4 <upgrade_214> + Upgrading from 2.1.2 to 2.1.3 <upgrade_213> + Upgrading from 2.1.1 to 2.1.2 <upgrade_212> + Upgrading from 2.1.0 to 2.1.1 <upgrade_211> + Upgrading from 2.0.3 to 2.1.0 <upgrade_210> + Upgrading from 2.0.2 to 2.0.3 <upgrade_203> + Upgrading from 2.0.1 to 2.0.2 <upgrade_202> + Upgrading from 2.0 to 2.0.1 <upgrade_201> + Upgrading from 1.7.2 to 2.0 <upgrade_200> + Upgrading from 1.7.1 to 1.7.2 <upgrade_172> + Upgrading from 1.7.0 to 1.7.1 <upgrade_171> + Upgrading from 1.6.3 to 1.7.0 <upgrade_170> + Upgrading from 1.6.2 to 1.6.3 <upgrade_163> + Upgrading from 1.6.1 to 1.6.2 <upgrade_162> + Upgrading from 1.6.0 to 1.6.1 <upgrade_161> + Upgrading from 1.5.4 to 1.6.0 <upgrade_160> + Upgrading from 1.5.3 to 1.5.4 <upgrade_154> + Upgrading from 1.5.2 to 1.5.3 <upgrade_153> + Upgrading from 1.5.0 or 1.5.1 to 1.5.2 <upgrade_152> + Upgrading from 1.4.1 to 1.5.0 <upgrade_150> + Upgrading from 1.4.0 to 1.4.1 <upgrade_141> + Upgrading from 1.3.3 to 1.4.0 <upgrade_140> + Upgrading from 1.3.2 to 1.3.3 <upgrade_133> + Upgrading from 1.3.1 to 1.3.2 <upgrade_132> + Upgrading from 1.3 to 1.3.1 <upgrade_131> + Upgrading from 1.2 to 1.3 <upgrade_130> + Upgrading from 1.1 to 1.2 <upgrade_120> + Upgrading from Beta 1.0 to Beta 1.1 <upgrade_b11> |