/xsql/funcs_ast_validator.go

https://github.com/emqx/kuiper · Go · 421 lines · 391 code · 29 blank · 1 comment · 225 complexity · e684258441236d7bec105a51062f28d6 MD5 · raw file

  1. package xsql
  2. import (
  3. "fmt"
  4. "github.com/emqx/kuiper/plugins"
  5. "strings"
  6. )
  7. type AllowTypes struct {
  8. types []Literal
  9. }
  10. func validateFuncs(funcName string, args []Expr) error {
  11. lowerName := strings.ToLower(funcName)
  12. if _, ok := mathFuncMap[lowerName]; ok {
  13. return validateMathFunc(funcName, args)
  14. } else if _, ok := strFuncMap[lowerName]; ok {
  15. return validateStrFunc(funcName, args)
  16. } else if _, ok := convFuncMap[lowerName]; ok {
  17. return validateConvFunc(lowerName, args)
  18. } else if _, ok := hashFuncMap[lowerName]; ok {
  19. return validateHashFunc(lowerName, args)
  20. } else if _, ok := jsonFuncMap[lowerName]; ok {
  21. return validateJsonFunc(lowerName, args)
  22. } else if _, ok := otherFuncMap[lowerName]; ok {
  23. return validateOtherFunc(lowerName, args)
  24. } else if _, ok := aggFuncMap[lowerName]; ok {
  25. return validateAggFunc(lowerName, args)
  26. } else {
  27. if nf, err := plugins.GetFunction(funcName); err != nil {
  28. return err
  29. } else {
  30. var targs []interface{}
  31. for _, arg := range args {
  32. targs = append(targs, arg)
  33. }
  34. return nf.Validate(targs)
  35. }
  36. }
  37. }
  38. func validateMathFunc(name string, args []Expr) error {
  39. len := len(args)
  40. switch name {
  41. case "abs", "acos", "asin", "atan", "ceil", "cos", "cosh", "exp", "ln", "log", "round", "sign", "sin", "sinh",
  42. "sqrt", "tan", "tanh":
  43. if err := validateLen(name, 1, len); err != nil {
  44. return err
  45. }
  46. if isStringArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  47. return produceErrInfo(name, 0, "number - float or int")
  48. }
  49. case "bitand", "bitor", "bitxor":
  50. if err := validateLen(name, 2, len); err != nil {
  51. return err
  52. }
  53. if isFloatArg(args[0]) || isStringArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  54. return produceErrInfo(name, 0, "int")
  55. }
  56. if isFloatArg(args[1]) || isStringArg(args[1]) || isTimeArg(args[1]) || isBooleanArg(args[1]) {
  57. return produceErrInfo(name, 1, "int")
  58. }
  59. case "bitnot":
  60. if err := validateLen(name, 1, len); err != nil {
  61. return err
  62. }
  63. if isFloatArg(args[0]) || isStringArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  64. return produceErrInfo(name, 0, "int")
  65. }
  66. case "atan2", "mod", "power":
  67. if err := validateLen(name, 2, len); err != nil {
  68. return err
  69. }
  70. if isStringArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  71. return produceErrInfo(name, 0, "number - float or int")
  72. }
  73. if isStringArg(args[1]) || isTimeArg(args[1]) || isBooleanArg(args[1]) {
  74. return produceErrInfo(name, 1, "number - float or int")
  75. }
  76. case "rand":
  77. if err := validateLen(name, 0, len); err != nil {
  78. return err
  79. }
  80. }
  81. return nil
  82. }
  83. func validateStrFunc(name string, args []Expr) error {
  84. len := len(args)
  85. switch name {
  86. case "concat":
  87. if len == 0 {
  88. return fmt.Errorf("The arguments for %s should be at least one.\n", name)
  89. }
  90. for i, a := range args {
  91. if isNumericArg(a) || isTimeArg(a) || isBooleanArg(a) {
  92. return produceErrInfo(name, i, "string")
  93. }
  94. }
  95. case "endswith", "indexof", "regexp_matches", "startswith":
  96. if err := validateLen(name, 2, len); err != nil {
  97. return err
  98. }
  99. for i := 0; i < 2; i++ {
  100. if isNumericArg(args[i]) || isTimeArg(args[i]) || isBooleanArg(args[i]) {
  101. return produceErrInfo(name, i, "string")
  102. }
  103. }
  104. case "format_time":
  105. if err := validateLen(name, 2, len); err != nil {
  106. return err
  107. }
  108. if isNumericArg(args[0]) || isStringArg(args[0]) || isBooleanArg(args[0]) {
  109. return produceErrInfo(name, 0, "datetime")
  110. }
  111. if isNumericArg(args[1]) || isTimeArg(args[1]) || isBooleanArg(args[1]) {
  112. return produceErrInfo(name, 1, "string")
  113. }
  114. case "regexp_replace":
  115. if err := validateLen(name, 3, len); err != nil {
  116. return err
  117. }
  118. for i := 0; i < 3; i++ {
  119. if isNumericArg(args[i]) || isTimeArg(args[i]) || isBooleanArg(args[i]) {
  120. return produceErrInfo(name, i, "string")
  121. }
  122. }
  123. case "length", "lower", "ltrim", "numbytes", "rtrim", "trim", "upper":
  124. if err := validateLen(name, 1, len); err != nil {
  125. return err
  126. }
  127. if isNumericArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  128. return produceErrInfo(name, 0, "string")
  129. }
  130. case "lpad", "rpad":
  131. if err := validateLen(name, 2, len); err != nil {
  132. return err
  133. }
  134. if isNumericArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  135. return produceErrInfo(name, 0, "string")
  136. }
  137. if isFloatArg(args[1]) || isTimeArg(args[1]) || isBooleanArg(args[1]) || isStringArg(args[1]) {
  138. return produceErrInfo(name, 1, "int")
  139. }
  140. case "substring":
  141. if len != 2 && len != 3 {
  142. return fmt.Errorf("the arguments for substring should be 2 or 3")
  143. }
  144. if isNumericArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  145. return produceErrInfo(name, 0, "string")
  146. }
  147. for i := 1; i < len; i++ {
  148. if isFloatArg(args[i]) || isTimeArg(args[i]) || isBooleanArg(args[i]) || isStringArg(args[i]) {
  149. return produceErrInfo(name, i, "int")
  150. }
  151. }
  152. if s, ok := args[1].(*IntegerLiteral); ok {
  153. sv := s.Val
  154. if sv < 0 {
  155. return fmt.Errorf("The start index should not be a nagtive integer.")
  156. }
  157. if len == 3 {
  158. if e, ok1 := args[2].(*IntegerLiteral); ok1 {
  159. ev := e.Val
  160. if ev < sv {
  161. return fmt.Errorf("The end index should be larger than start index.")
  162. }
  163. }
  164. }
  165. }
  166. case "split_value":
  167. if len != 3 {
  168. return fmt.Errorf("the arguments for split_value should be 3")
  169. }
  170. if isNumericArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  171. return produceErrInfo(name, 0, "string")
  172. }
  173. if isNumericArg(args[1]) || isTimeArg(args[1]) || isBooleanArg(args[1]) {
  174. return produceErrInfo(name, 1, "string")
  175. }
  176. if isFloatArg(args[2]) || isTimeArg(args[2]) || isBooleanArg(args[2]) || isStringArg(args[2]) {
  177. return produceErrInfo(name, 2, "int")
  178. }
  179. if s, ok := args[2].(*IntegerLiteral); ok {
  180. if s.Val < 0 {
  181. return fmt.Errorf("The index should not be a nagtive integer.")
  182. }
  183. }
  184. }
  185. return nil
  186. }
  187. func validateConvFunc(name string, args []Expr) error {
  188. len := len(args)
  189. switch name {
  190. case "cast":
  191. if err := validateLen(name, 2, len); err != nil {
  192. return err
  193. }
  194. a := args[1]
  195. if !isStringArg(a) {
  196. return produceErrInfo(name, 1, "string")
  197. }
  198. if av, ok := a.(*StringLiteral); ok {
  199. if !(av.Val == "bigint" || av.Val == "float" || av.Val == "string" || av.Val == "boolean" || av.Val == "datetime") {
  200. return fmt.Errorf("Expect one of following value for the 2nd parameter: bigint, float, string, boolean, datetime.")
  201. }
  202. }
  203. case "chr":
  204. if err := validateLen(name, 1, len); err != nil {
  205. return err
  206. }
  207. if isFloatArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  208. return produceErrInfo(name, 0, "int")
  209. }
  210. case "encode":
  211. if err := validateLen(name, 2, len); err != nil {
  212. return err
  213. }
  214. if isNumericArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  215. return produceErrInfo(name, 0, "string")
  216. }
  217. a := args[1]
  218. if !isStringArg(a) {
  219. return produceErrInfo(name, 1, "string")
  220. }
  221. if av, ok := a.(*StringLiteral); ok {
  222. if av.Val != "base64" {
  223. return fmt.Errorf("Only base64 is supported for the 2nd parameter.")
  224. }
  225. }
  226. case "trunc":
  227. if err := validateLen(name, 2, len); err != nil {
  228. return err
  229. }
  230. if isTimeArg(args[0]) || isBooleanArg(args[0]) || isStringArg(args[0]) {
  231. return produceErrInfo(name, 0, "number - float or int")
  232. }
  233. if isFloatArg(args[1]) || isTimeArg(args[1]) || isBooleanArg(args[1]) || isStringArg(args[1]) {
  234. return produceErrInfo(name, 1, "int")
  235. }
  236. }
  237. return nil
  238. }
  239. func validateHashFunc(name string, args []Expr) error {
  240. len := len(args)
  241. switch name {
  242. case "md5", "sha1", "sha224", "sha256", "sha384", "sha512":
  243. if err := validateLen(name, 1, len); err != nil {
  244. return err
  245. }
  246. if isNumericArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  247. return produceErrInfo(name, 0, "string")
  248. }
  249. }
  250. return nil
  251. }
  252. func validateOtherFunc(name string, args []Expr) error {
  253. len := len(args)
  254. switch name {
  255. case "isNull":
  256. if err := validateLen(name, 1, len); err != nil {
  257. return err
  258. }
  259. case "nanvl":
  260. if err := validateLen(name, 2, len); err != nil {
  261. return err
  262. }
  263. if isIntegerArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) || isStringArg(args[0]) {
  264. return produceErrInfo(name, 1, "float")
  265. }
  266. case "newuuid":
  267. if err := validateLen(name, 0, len); err != nil {
  268. return err
  269. }
  270. case "mqtt":
  271. if err := validateLen(name, 1, len); err != nil {
  272. return err
  273. }
  274. if isIntegerArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) || isStringArg(args[0]) || isFloatArg(args[0]) {
  275. return produceErrInfo(name, 0, "meta reference")
  276. }
  277. if p, ok := args[0].(*MetaRef); ok {
  278. name := strings.ToLower(p.Name)
  279. if name != "topic" && name != "messageid" {
  280. return fmt.Errorf("Parameter of mqtt function can be only topic or messageid.")
  281. }
  282. }
  283. case "meta":
  284. if err := validateLen(name, 1, len); err != nil {
  285. return err
  286. }
  287. if _, ok := args[0].(*MetaRef); ok {
  288. return nil
  289. }
  290. expr := args[0]
  291. for {
  292. if be, ok := expr.(*BinaryExpr); ok {
  293. if _, ok := be.LHS.(*MetaRef); ok && be.OP == ARROW {
  294. return nil
  295. }
  296. expr = be.LHS
  297. } else {
  298. break
  299. }
  300. }
  301. return produceErrInfo(name, 0, "meta reference")
  302. }
  303. return nil
  304. }
  305. func validateJsonFunc(name string, args []Expr) error {
  306. len := len(args)
  307. if err := validateLen(name, 2, len); err != nil {
  308. return err
  309. }
  310. if !isStringArg(args[1]) {
  311. return produceErrInfo(name, 1, "string")
  312. }
  313. return nil
  314. }
  315. func validateAggFunc(name string, args []Expr) error {
  316. len := len(args)
  317. switch name {
  318. case "avg", "max", "min", "sum":
  319. if err := validateLen(name, 1, len); err != nil {
  320. return err
  321. }
  322. if isStringArg(args[0]) || isTimeArg(args[0]) || isBooleanArg(args[0]) {
  323. return produceErrInfo(name, 0, "number - float or int")
  324. }
  325. case "count":
  326. if err := validateLen(name, 1, len); err != nil {
  327. return err
  328. }
  329. case "collect":
  330. if err := validateLen(name, 1, len); err != nil {
  331. return err
  332. }
  333. case "deduplicate":
  334. if err := validateLen(name, 2, len); err != nil {
  335. return err
  336. }
  337. if !isBooleanArg(args[1]) {
  338. return produceErrInfo(name, 1, "bool")
  339. }
  340. }
  341. return nil
  342. }
  343. // Index is starting from 0
  344. func produceErrInfo(name string, index int, expect string) (err error) {
  345. index++
  346. err = fmt.Errorf("Expect %s type for %d parameter of function %s.", expect, index, name)
  347. return
  348. }
  349. func validateLen(funcName string, exp, actual int) error {
  350. if actual != exp {
  351. return fmt.Errorf("The arguments for %s should be %d.", funcName, exp)
  352. }
  353. return nil
  354. }
  355. func isNumericArg(arg Expr) bool {
  356. if _, ok := arg.(*NumberLiteral); ok {
  357. return true
  358. } else if _, ok := arg.(*IntegerLiteral); ok {
  359. return true
  360. }
  361. return false
  362. }
  363. func isIntegerArg(arg Expr) bool {
  364. if _, ok := arg.(*IntegerLiteral); ok {
  365. return true
  366. }
  367. return false
  368. }
  369. func isFloatArg(arg Expr) bool {
  370. if _, ok := arg.(*NumberLiteral); ok {
  371. return true
  372. }
  373. return false
  374. }
  375. func isBooleanArg(arg Expr) bool {
  376. if _, ok := arg.(*BooleanLiteral); ok {
  377. return true
  378. }
  379. return false
  380. }
  381. func isStringArg(arg Expr) bool {
  382. if _, ok := arg.(*StringLiteral); ok {
  383. return true
  384. }
  385. return false
  386. }
  387. func isTimeArg(arg Expr) bool {
  388. if _, ok := arg.(*TimeLiteral); ok {
  389. return true
  390. }
  391. return false
  392. }