OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
[#64348] validate formula syntax by building AST
Tobias Dillmann1f0530aec0e4
diff --git a/app/models/custom_field/calculated_value.rb b/app/models/custom_field/calculated_value.rbindex 8182a2f6ba2..25e7b4d707f 100644--- a/app/models/custom_field/calculated_value.rb+++ b/app/models/custom_field/calculated_value.rb@@ -55,14 +55,13 @@ module CustomField::CalculatedValuereturnend- # WP-64348: check for valid (i.e., visible & enabled) custom field references (see #cf_ids_used_in_formula)-- calculation_result = perform_calculation- unless calculation_result+ unless valid_formula_syntax?errors.add(:formula, :invalid)returnend+ # WP-64348: check for valid (i.e., visible & enabled) custom field references (see #cf_ids_used_in_formula)+# TODO: consider differentiating between a formula that contains missing variables, invalid# syntax, or mathematical errors.true # return anything to appease RuboCop for now@@ -93,17 +92,19 @@ module CustomField::CalculatedValueprivate- def perform_calculation- # Dentaku will return nil if the formula is invalid.- # Accept both cf_123 and {{cf_123}} in the formula string- formula_for_eval = formula_string.gsub(/\{\{(cf_\d+)}}/, '\1')+ def calculator+ @calculator ||= Dentaku::Calculator.new(case_sensitive: true)+ end- variables = cf_ids_used_in_formula(formula_for_eval).map do |cf_id|- # TODO: insert real value here instead of hardcoded number- ["cf_#{cf_id}", 1]- end+ def valid_formula_syntax?+ # Accept both cf_123 and {{cf_123}} in the formula string+ f = formula_string.gsub(/\{\{(cf_\d+)}}/, '\1')- Dentaku::Calculator.new.evaluate(formula_for_eval, variables.to_h)+ # Attempt to parse the formula. If no error is returned, the formula is syntactically valid.+ calculator.ast(f)+ true+ rescue Dentaku::ParseError, Dentaku::TokenizerError+ falseenddef formula_contains_only_allowed_characters?