Index: openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl,v diff -u -r1.28 -r1.29 --- openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl 3 Nov 2018 19:52:29 -0000 1.28 +++ openacs-4/packages/acs-templating/tcl/spellcheck-procs.tcl 3 Sep 2024 15:37:35 -0000 1.29 @@ -29,15 +29,15 @@ if { $merge_text eq "" } { - return {} - } + return {} + } # loop through errors and substitute the corrected words for #errnum#. set i 0 while { [ns_set find $__form__ $element_id.error_$i] != -1 } { - regsub "\#$i\#" $merge_text [ns_set get $__form__ $element_id.error_$i] merge_text - ns_set delkey $__form__ $element_id.error_$i - incr i + regsub "\#$i\#" $merge_text [ns_set get $__form__ $element_id.error_$i] merge_text + ns_set delkey $__form__ $element_id.error_$i + incr i } ns_set cput $__form__ $element_id $merge_text @@ -63,97 +63,98 @@ set richtext_p [expr {$element(datatype) eq "richtext"}] if { $richtext_p } { - # special treatment for the "richtext" datatype. - set format [template::util::richtext::get_property format [lindex $values 0]] - if { $merge_text ne "" } { + # special treatment for the "richtext" datatype. + set format [template::util::richtext::get_property format [lindex $values 0]] + if { $merge_text ne "" } { set richtext_value [lindex [template::data::transform::richtext element] 0] return [list [template::util::richtext::set_property contents $richtext_value $merge_text]] - } - set contents [template::util::richtext::get_property contents [lindex $values 0]] + } + set contents [template::util::richtext::get_property contents [lindex $values 0]] } else { - if { $merge_text ne "" } { + if { $merge_text ne "" } { return [list $merge_text] - } - set contents [lindex $values 0] + } + set contents [lindex $values 0] } if { $contents eq "" } { - return $values - } - # if language is empty string don't spellcheck - set spellcheck_p [ad_decode [set language [ns_queryget $element(id).spellcheck]] ":nospell:" 0 "" 0 1] + return $values + } + # if language is empty or :nospell: string don't spellcheck + set language [ns_queryget $element(id).spellcheck] + set spellcheck_p [expr {$language ni {":nospell:" ""}}] # perform spellchecking or not? - if { $spellcheck_p } { + if { $spellcheck_p } { - template::util::spellcheck::get_element_formtext \ - -text $contents \ - -var_to_spellcheck $element(id) \ - -language $language \ - -error_num_ref error_num \ - -formtext_to_display_ref formtext_to_display \ - -just_the_errwords_ref {} \ - -html - - if { $error_num > 0 } { + template::util::spellcheck::get_element_formtext \ + -text $contents \ + -var_to_spellcheck $element(id) \ + -language $language \ + -error_num_ref error_num \ + -formtext_to_display_ref formtext_to_display \ + -just_the_errwords_ref {} \ + -html - # there was at least one error. + if { $error_num > 0 } { + # there was at least one error. + # disable element validation since that will conflict with # the spellchecking DAVEB template::element::set_properties $element(form_id) $element(id) -validate [list] - template::element::set_error $element(form_id) $element(id) " - [ad_decode $error_num 1 "Found one error." "Found $error_num errors."] Please correct, if necessary." + template::element::set_error $element(form_id) $element(id) " + [expr {$error_num == 1 ? "Found one error." : "Found $error_num errors."}] Please correct, if necessary." - # switch to display mode so we can show our inline mini-form with suggestions. - template::element::set_properties $element(form_id) $element(id) mode display + # switch to display mode so we can show our inline mini-form with suggestions. + template::element::set_properties $element(form_id) $element(id) mode display - if { $richtext_p } { + if { $richtext_p } { # mutate datatype to prevent validation of spellcheck # form data by richtext validation DAVEB template::element::set_properties $element(form_id) $element(id) -datatype text - append formtext_to_display " + append formtext_to_display " " - } + } - # This is needed in order to display the form text noquoted in the "show errors" page ... - template::element::set_properties $element(form_id) $element(id) -display_value $formtext_to_display + # This is needed in order to display the form text noquoted in the "show errors" page ... + template::element::set_properties $element(form_id) $element(id) -display_value $formtext_to_display - set contents $formtext_to_display - } + set contents $formtext_to_display + } } - + # no spellchecking was to take place, or there were no errors. if { $richtext_p } { - return [list [template::util::richtext::set_property contents [lindex $values 0] $contents]] + return [list [template::util::richtext::set_property contents [lindex $values 0] $contents]] } else { - return [list $contents] + return [list $contents] } } ad_proc -public template::util::spellcheck::get_sorted_list_with_unique_elements { -the_list:required } { - + Converts a list of possibly duplicate elements (words) into a sorted list where no duplicates exist. - + @param the_list The list of possibly duplicate elements. - + } { set sorted_list [lsort -dictionary $the_list] set new_list [list] - + set old_element "XXinitial_conditionXX" foreach list_element $sorted_list { - if { $list_element ne $old_element } { - lappend new_list $list_element - } - set old_element $list_element + if { $list_element ne $old_element } { + lappend new_list $list_element + } + set old_element $list_element } - + return $new_list - + } ad_proc -public template::util::spellcheck::get_element_formtext { @@ -168,12 +169,12 @@ } { @param text The string to check for spelling errors. - + @param html_p Does the text have html in it? If so, we strip out html tags in the string we feed to ispell (or aspell). @param no_abort_p Set this tue for testing purposes (e.g. aa_test). - + @param var_to_spellcheck The name of the text input type or textarea that holds this text (e.g., "email_body") - + } { # We need a "var_to_spellcheck" argument so that we may name the hidden errnum vars @@ -183,41 +184,38 @@ # if HTML then substitute out all HTML tags if { $html_p } { - regsub -all {<[^<]*>} $text_to_spell_check "" text_to_spell_check + regsub -all -- {<[^<]*>} $text_to_spell_check "" text_to_spell_check } - set tmpfile [ns_mktemp "/tmp/webspellXXXXXX"] - set f [open $tmpfile w] + set f [file tempfile tmpfile [ad_tmpdir]/webspell-XXXXXX] puts $f $text_to_spell_check close $f - + set lines [split $text "\n"] # Support for local, localized, dictionaries (UI to add to them is not implemented yet!) - set suffix [ad_decode $language "" "" "-$language"] + set suffix [expr {$language ne "" ? "-$language" : ""}] set dictionaryfile [file join [acs_package_root_dir acs-templating] resources forms webspell-local-dict$suffix] - # The webspell wrapper is necessary because ispell requires - # the HOME environment set, and setting env(HOME) doesn't appear - # to work from AOLserver. + # The webspell wrapper is used to achieve independence from + # nsd's env(HOME). set spelling_wrapper [file join $::acs::rootdir bin webspell] - if {![file executable $spelling_wrapper]} { - # - # In case no_abort is given we just return the error - # message. Otherwise an ad_return_error is raised and the - # script is ad_script_aborted. - # - if {!$no_abort_p} { - ad_return_error "Webspell could not be executed" \ - "Spell-checking is enabled but the spell-check wrapper\ - ($::acs::rootdir/bin/webspell) returns not be executed.\ - Check that the wrapper exists, and that its permissions are correct." - ad_script_abort - } else { - error $errmsg - } + # + # In case no_abort is given we just return the error + # message. Otherwise an ad_return_error is raised and the + # script is ad_script_aborted. + # + if {!$no_abort_p} { + ad_return_error "Webspell could not be executed" \ + "Spell-checking is enabled but the spell-check wrapper\ + ($::acs::rootdir/bin/webspell) returns not be executed.\ + Check that the wrapper exists, and that its permissions are correct." + ad_script_abort + } else { + error $errmsg + } } set spellchecker_path [nsv_get spellchecker path] @@ -236,25 +234,25 @@ #ns_log notice WRAPPER=[list |$spelling_wrapper [ns_info home] $spellchecker_path $lang_and_enc $dictionaryfile $tmpfile] if {[catch { - set ispell_lines [exec $spelling_wrapper [ns_info home] $spellchecker_path $lang_and_enc $dictionaryfile $tmpfile] + set ispell_lines [exec $spelling_wrapper [ns_info home] $spellchecker_path $lang_and_enc $dictionaryfile $tmpfile] } errmsg]} { - #ns_log notice "errorMsg = $errmsg" - - # - # In case no_abort is given we just return the error - # message. Otherwise an ad_return_error is raised and the - # script is ad_script_aborted. - # - if {!$no_abort_p} { - ad_return_error "No dictionary found" \ - "Spell-checking is enabled but the spell-check dictionary\ - could not be reached. Check that the dictionary exists,\ - and that its permissions are correct.\ -

Here is the error message: 

$errmsg
" - ad_script_abort - } else { - error $errmsg - } + #ns_log notice "errorMsg = $errmsg" + + # + # In case no_abort is given we just return the error + # message. Otherwise an ad_return_error is raised and the + # script is ad_script_aborted. + # + if {!$no_abort_p} { + ad_return_error "No dictionary found" \ + "Spell-checking is enabled but the spell-check dictionary\ + could not be reached. Check that the dictionary exists,\ + and that its permissions are correct.\ +

Here is the error message: 

$errmsg
" + ad_script_abort + } else { + error $errmsg + } } file delete -- $tmpfile @@ -264,11 +262,11 @@ # Ispell is done. Start manipulating the result string. # #### - + set ispell_lines [split $ispell_lines "\n"] # Remove the version line. if { [llength $ispell_lines] > 0 } { - set ispell_lines [lreplace $ispell_lines 0 0] + set ispell_lines [lreplace $ispell_lines 0 0] } #### @@ -278,70 +276,70 @@ set error_num 0 set errors [list] - + set processed_text "" set line [lindex $lines 0] foreach ispell_line $ispell_lines { - switch -glob -- $ispell_line { - \#* { - regexp "^\# (\[^ \]+) (\[0-9\]+)" $ispell_line dummy word pos - regsub $word $line "\#$error_num\#" line - lappend errors [list miss $error_num $word dummy] - incr error_num - } - &* { - regexp {^& ([^ ]+) ([0-9]+) ([0-9]+): (.*)$} $ispell_line dummy word n_options pos options - regsub $word $line "\#$error_num\#" line - lappend errors [list nearmiss $error_num $word $options] - incr error_num - } - "" { - append processed_text "$line\n" - if { [llength $lines] > 0 } { - set lines [lreplace $lines 0 0] - set line [lindex $lines 0] - } - } - } + switch -glob -- $ispell_line { + \#* { + regexp "^\# (\[^ \]+) (\[0-9\]+)" $ispell_line dummy word pos + regsub $word $line "\#$error_num\#" line + lappend errors [list miss $error_num $word dummy] + incr error_num + } + &* { + regexp {^& ([^ ]+) ([0-9]+) ([0-9]+): (.*)$} $ispell_line dummy word n_options pos options + regsub $word $line "\#$error_num\#" line + lappend errors [list nearmiss $error_num $word $options] + incr error_num + } + "" { + append processed_text "$line\n" + if { [llength $lines] > 0 } { + set lines [lreplace $lines 0 0] + set line [lindex $lines 0] + } + } + } } set formtext $processed_text set error_list [join $errors] foreach { errtype errnum errword erroptions } $error_list { - set wordlen [string length $errword] - - if {"miss" eq $errtype} { - regsub "\#$errnum\#" $formtext "" formtext - } elseif {"nearmiss" eq $errtype} { - regsub -all ", " $erroptions "," erroptions - set options [split $erroptions ","] - set select_text "" - regsub "\#$errnum\#" $formtext $select_text formtext - } + set wordlen [string length $errword] + + if {"miss" eq $errtype} { + regsub "\#$errnum\#" $formtext "" formtext + } elseif {"nearmiss" eq $errtype} { + regsub -all -- ", " $erroptions "," erroptions + set options [split $erroptions ","] + set select_text "" + regsub "\#$errnum\#" $formtext $select_text formtext + } } - + #### # formtext_to_display #### upvar $formtext_to_display_ref formtext_to_display - regsub -all "\r\n" $formtext "
" formtext_to_display + regsub -all -- "\r\n" $formtext "
" formtext_to_display # We replace with because misspelled text in link titles - # would lead to strange browser behavior where the select boxes with the + # would lead to strange browser behavior where the select boxes with the # proposed changes would itself be a link!!! # It seemed like an okay idea to make the text underlined so it would a) work, # b) still resemble a link ... - regsub -all {} $formtext_to_display "" formtext_to_display - regsub -all {} $formtext_to_display "" formtext_to_display + regsub -all -- {} $formtext_to_display "" formtext_to_display + regsub -all -- {} $formtext_to_display "" formtext_to_display append formtext_to_display "" @@ -351,14 +349,14 @@ #### if { $just_the_errwords_ref ne ""} { - - upvar $just_the_errwords_ref just_the_errwords - - set just_the_errwords [list] - foreach err $errors { - lappend just_the_errwords [lindex $err 2] - } - + + upvar $just_the_errwords_ref just_the_errwords + + set just_the_errwords [list] + foreach err $errors { + lappend just_the_errwords [lindex $err 2] + } + } } @@ -368,71 +366,73 @@ Returns a list of spellcheck properties in array setable format. } { upvar $element_ref element - + if { [set spellcheck_value [ns_queryget $element(id).spellcheck]] eq "" } { - - # The user hasn't been able to state whether (s)he wants spellchecking to be performed or not. - # That's either because spell-checking is disabled for this element, or we're not dealing with a submit. - # Whichever it is, let's see if, and then how, we should render the spellcheck "sub widget". - - # Do the "cheap" checks first and then (if needed) read the parameter and do additional checks. - if { $element(mode) eq "display" - || [info exists element(nospell)] - || [nsv_get spellchecker path] eq "" } { + # The user hasn't been able to state whether (s)he wants spellchecking to be performed or not. + # That's either because spell-checking is disabled for this element, or we're not dealing with a submit. + # Whichever it is, let's see if, and then how, we should render the spellcheck "sub widget". - set spellcheck_p 0 - } else { - array set widget_info [string trim [parameter::get_from_package_key \ - -package_key acs-templating \ - -parameter SpellcheckFormWidgets \ - -default ""]] - - set spellcheck_p [expr {[array size widget_info] - && ($element(widget) eq "richtext" || - $element(widget) eq "textarea" || - $element(widget) eq "text") - && [info exists widget_info($element(widget))] + # Do the "cheap" checks first and then (if needed) read the parameter and do additional checks. + + if { $element(mode) eq "display" + || [info exists element(nospell)] + || [nsv_get spellchecker path] eq "" } { + + set spellcheck_p 0 + } else { + array set widget_info [string trim [parameter::get_from_package_key \ + -package_key acs-templating \ + -parameter SpellcheckFormWidgets \ + -default ""]] + + set spellcheck_p [expr {[array size widget_info] + && ($element(widget) eq "richtext" || + $element(widget) eq "textarea" || + $element(widget) eq "text") + && [info exists widget_info($element(widget))] && [set widget_info($element(widget))] }] - } - - if { $spellcheck_p } { - # This is not a submit; we are rendering the form element for the first time and - # since the spellcheck "sub widget" is to be displayed we'll also want to know - # which option should be selected by default. + } - array set spellcheck {render_p 1 perform_p 1} + if { $spellcheck_p } { + # This is not a submit; we are rendering the form element for the first time and + # since the spellcheck "sub widget" is to be displayed we'll also want to know + # which option should be selected by default. - if { $widget_info(${element(widget)}) } { - set spellcheck(selected_option) [nsv_get spellchecker default_lang] - } else { - set spellcheck(selected_option) ":nospell:" - } + array set spellcheck {render_p 1 perform_p 1} - } else { + if { $widget_info(${element(widget)}) } { + set spellcheck(selected_option) [nsv_get spellchecker default_lang] + } else { + set spellcheck(selected_option) ":nospell:" + } - array set spellcheck {render_p 0 perform_p 0} + } else { - # set this to something so the script won't choke. - set spellcheck(selected_option) ":nospell:" - } - + array set spellcheck {render_p 0 perform_p 0} + + # set this to something so the script won't choke. + set spellcheck(selected_option) ":nospell:" + } + } else { - - # The user has explicitly stated if (s)he wants spellchecking to be performed - # on the text or not. Hence we are in submit mode with spell-checking enabled. - # Let's check which it is and keep record of the states of our select menu in - # case the error page is shown (because of an error in a neighboring element). - set spellcheck(selected_option) $spellcheck_value - set spellcheck(render_p) 1 + # The user has explicitly stated if (s)he wants spellchecking to be performed + # on the text or not. Hence we are in submit mode with spell-checking enabled. + # Let's check which it is and keep record of the states of our select menu in + # case the error page is shown (because of an error in a neighboring element). - if {":nospell:" eq $spellcheck(selected_option)} { - set spellcheck(perform_p) 0 - } else { - set spellcheck(perform_p) 1 - } + set spellcheck(selected_option) $spellcheck_value + + if {":nospell:" eq $spellcheck(selected_option)} { + set spellcheck(perform_p) 0 + set spellcheck(render_p) 0 + + } else { + set spellcheck(perform_p) 1 + set spellcheck(render_p) 1 + } } return [array get spellcheck]