Merge pull request #1476 from coopTilleuls/confirm-exit

Ask before quitting a page with unsaved changes

DependencyInjection/Configuration.php

@@ -74,6 +74,7 @@ class Configuration implements ConfigurationInterface
                     ->addDefaultsIfNotSet()
                     ->children()
                         ->scalarNode('html5_validate')->defaultValue(true)->end()
+                        ->scalarNode('confirm_exit')->defaultValue(true)->end()
                     ->end()
                 ->end()
                 ->arrayNode('dashboard')

Resources/doc/reference/configuration.rst

@@ -27,6 +27,7 @@ Full Configuration Options
         title_logo: bundles/sonataadmin/logo_title.png
         options:
             html5_validate: false # does not use html5 validation
+            confirm_exit:   false # disable confirmation when quitting with unsaved changes
             
         templates:
             # default global templates

Resources/public/base.js

@@ -1,5 +1,8 @@
 jQuery(document).ready(function() {
     jQuery('html').removeClass('no-js');
+    if (window.SONATA_CONFIG.CONFIRM_EXIT) {
+        jQuery('.sonata-ba-form form').confirmExit(window.SONATA_TRANSLATIONS.CONFIRM_EXIT);
+    }
     Admin.add_pretty_errors(document);
     Admin.add_filters(document);
     Admin.set_object_field_value(document);

Resources/public/jquery/jquery.confirmExit.js

@@ -0,0 +1,38 @@
+/*!
+* jQuery confirmExit plugin
+* https://github.com/dunglas/jquery.confirmExit
+*
+* Copyright 2012 Kévin Dunglas <dunglas@gmail.com>
+* Released under the MIT license
+* http://www.opensource.org/licenses/mit-license.php
+*/
+(function ($) {
+	$.fn.confirmExit = function(message) {
+		var confirmExit = false;
+
+		$('input, textarea, select', this).on('change keyup', function() {
+			// Do not set the event handler if not needed
+			if (!confirmExit) {
+				confirmExit = true;
+
+				window.onbeforeunload = function(event) {
+					var e = event || window.event;
+
+					// For old IE and Firefox
+					if (e) {
+						e.returnValue = message;
+					}
+
+					return message;
+				}
+			}
+		});
+
+		this.submit(function() {
+			window.onbeforeunload = null;
+			confirmExit = false;
+		});
+
+		return this;
+	}
+	})(jQuery);

Resources/translations/SonataAdminBundle.bg.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.ca.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.cs.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.de.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>You have unsaved changes.</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.en.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>Select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>You have unsaved changes.</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.es.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.eu.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.fa.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.fr.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>Sélectionner</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>Vous avez effectué des modifications non sauvegardées.</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.hr.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.hu.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.it.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>Seleziona</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.ja.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.lb.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.nl.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.pl.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.pt.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>Selecionar</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.pt_BR.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.ro.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>Selectați</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.ru.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.sk.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.sl.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.uk.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/translations/SonataAdminBundle.zh_CN.xliff

@@ -346,6 +346,10 @@
               <source>list_select</source>
               <target>list_select</target>
             </trans-unit>
+            <trans-unit id="confirm_exit">
+                <source>confirm_exit</source>
+                <target>confirm_exit</target>
+            </trans-unit>
         </body>
     </file>
 </xliff>

Resources/views/standard_layout.html.twig

@@ -37,6 +37,14 @@ file that was distributed with this source code.
         {% endblock %}
 
         {% block javascripts %}
+            <script type="text/javascript">
+                window.SONATA_CONFIG = {
+                    CONFIRM_EXIT: {% if admin_pool.getOption('confirm_exit') %}true{% else %}false{% endif %}
+                };
+                window.SONATA_TRANSLATIONS = {
+                    CONFIRM_EXIT:  '{{ 'confirm_exit'|trans({}, 'SonataAdminBundle')|escape('js') }}'
+               };
+            </script>
             <script src="{{ asset('bundles/sonatajquery/jquery-1.8.3.js') }}" type="text/javascript"></script>
             <script src="{{ asset('bundles/sonatajquery/jquery-ui-1.8.23.js') }}" type="text/javascript"></script>
             <script src="{{ asset('bundles/sonatajquery/jquery-ui-i18n.js') }}" type="text/javascript"></script>
@@ -44,6 +52,7 @@ file that was distributed with this source code.
             <script src="{{ asset('bundles/sonataadmin/bootstrap/js/bootstrap.min.js') }}" type="text/javascript"></script>
 
             <script src="{{ asset('bundles/sonataadmin/jquery/jquery.form.js') }}" type="text/javascript"></script>
+            {% if admin_pool.getOption('confirm_exit') %}<script src="{{ asset('bundles/sonataadmin/jquery/jquery.confirmExit.js') }}" type="text/javascript"></script>{% endif %}
             <script src="{{ asset('bundles/sonataadmin/base.js') }}" type="text/javascript"></script>
         {% endblock %}