wp_query_rs 0.4.1

A rust implementation of the classic WP_Query utility to access WordPress posts outside of a WordPress environment.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
use mysql_common::{prelude::ToValue, Value};
use sql_paginatorr::LimitOffsetPair;

use crate::{
    params::Params, sql::SqlOrder, wp_post::post_status::PostStatus, PostType, SqlSearchOperators,
};

type StmtValues = Vec<Value>;

pub struct QueryBuilder<'a> {
    params: Params<'a>,
    query: String,
    values: StmtValues,
}

pub struct QueryAndValues(pub String, pub Vec<Value>);

impl<'a> QueryBuilder<'a> {
    pub fn new(params: Params<'a>) -> Self {
        Self {
            params,
            query: String::new(),
            values: vec![],
        }
    }

    pub fn query(mut self) -> QueryAndValues {
        let params = self.params;

        macro_rules! add_if_some_id {
            ($prop: ident, $query: expr) => {
                if let Some(id) = params.$prop {
                    self.query.push_str($query);
                    self.values.push(Value::UInt(id));
                }
            };
        }

        macro_rules! add_multiple_if_some_ids {
            ($prop: ident, $q: expr) => {
                if let Some(ids) = params.$prop {
                    let q_marks = implode_to_question_mark(&ids);
                    self.query.push_str(&format!($q, q_marks));

                    let ids = ids.into_iter().map(|id| Value::UInt(id));

                    self.values.extend(ids);
                }
            };
        }

        self.query.push_str(
            "SELECT DISTINCT(wp_posts.ID),post_author,comment_count,post_parent,menu_order,
            post_date,post_date_gmt,post_modified,post_modified_gmt,
            post_status,post_content,post_title,post_excerpt,comment_status,ping_status,
            post_password,post_name,to_ping,pinged,post_content_filtered,guid,
            post_type,post_mime_type
            FROM wp_posts",
        );

        let join_term = check_if_term_join_necessary(&params);
        let join_meta = check_if_meta_join_necessary(&params);
        let join_user = check_if_user_join_necessary(&params);
        let has_single_date = has_valid_single_date(&params);

        if join_meta {
            self.query
                .push_str(" INNER JOIN wp_postmeta ON wp_postmeta.post_id = wp_posts.ID");
        }

        if join_term {
            self.query.push_str(
                " INNER JOIN wp_term_relationships
            ON wp_posts.ID = wp_term_relationships.object_id
            INNER JOIN wp_term_taxonomy ON wp_term_taxonomy.term_taxonomy_id = wp_term_relationships.term_taxonomy_id
            INNER JOIN wp_terms ON wp_terms.term_id = wp_term_taxonomy.term_id",
            );
        }

        if join_user {
            self.query
                .push_str(" INNER JOIN wp_users ON wp_users.ID = wp_posts.post_author");
        }

        // Avoid dangling WHERE issue
        self.query.push_str(" WHERE 1 = 1");

        add_if_some_id!(author, " AND post_author = ?");

        if let Some(author_name) = params.author_name {
            self.query.push_str(" AND wp_users.user_nicename = ?");
            self.values.push(Value::Bytes(author_name.into()));
        }

        add_multiple_if_some_ids!(author__in, " AND post_author IN ({})");

        add_multiple_if_some_ids!(author__not_in, " AND post_author NOT IN ({})");

        /* Add Post Status conditions */
        if let Some(post_status) = params.post_status {
            push_post_status(&mut self.query, &mut self.values, &post_status);
        } else {
            self.query
                .push_str(&format!(" AND post_status = '{}'", PostStatus::Publish));
        }

        /* Add category, tag, and term conditions */
        if let Some(term_slugs) = params.term_slug_and {
            for term_slug in term_slugs.into_iter() {
                self.query.push_str(" AND wp_terms.slug = ?");
                self.values.push(Value::Bytes(term_slug.into()));
            }
        }

        if let Some(term_slugs) = params.term_slug_in {
            let q_marks = implode_to_question_mark(&term_slugs);

            self.query
                .push_str(&format!(" AND wp_terms.slug IN ({})", q_marks));

            let values = term_slugs.into_iter().map(|slug| Value::Bytes(slug.into()));

            self.values.extend(values);
        }

        add_multiple_if_some_ids!(term_in, " AND wp_terms.term_id IN ({})");

        add_multiple_if_some_ids!(term_not_in, " AND wp_terms.term_id NOT IN ({})");

        /* Tax Query */
        if let Some(queries) = params.tax_query {
            for (relationship, tax_queries) in queries.into_iter() {
                self.query.push_str(" AND");

                // Operator for comparing multiple tax queries
                let rel_str = relationship.to_string();

                for (i, tax_q) in tax_queries.into_iter().enumerate() {
                    // Add internal operator if length is greater than 1
                    if i > 0 {
                        self.query.push_str(" ");
                        self.query.push_str(&rel_str);
                    }

                    let q_marks = implode_to_question_mark(&tax_q.terms);

                    let prefix = "wp";
                    self.query.push_str(&format!(
                        " {}_{} {} ({})",
                        prefix, tax_q.field, tax_q.operator, q_marks
                    ));
                    self.values
                        .extend(tax_q.terms.into_iter().map(|v| Value::Bytes(v.into())))
                }
            }
        }

        /* Add search conditions */
        if let Some(keyword) = params.s {
            self.query
                .push_str(" AND wp_posts.post_content LIKE CONCAT('%',?,'%') OR wp_posts.post_title LIKE CONCAT('%',?,'%')");
            self.values.push(Value::Bytes(keyword.as_bytes().to_vec())); // Clone this so it can be used again
            self.values.push(Value::Bytes(keyword.into()));
        }

        /* Add page/post conditions */
        add_if_some_id!(p, " AND wp_posts.ID = ?");

        if let Some(name) = params.name {
            self.query.push_str(" AND wp_posts.post_name = ?");
            self.values.push(Value::Bytes(name.into()));
        }

        /* Post types */
        push_post_type(&mut self.query, &mut self.values, params.post_type);

        add_if_some_id!(post_parent, " AND wp_posts.post_parent = ?");

        add_multiple_if_some_ids!(post_parent__in, " AND wp_posts.post_parent IN ({})");

        add_multiple_if_some_ids!(post_parent__not_in, " AND wp_posts.post_parent NOT IN ({})");

        add_multiple_if_some_ids!(post__in, " AND wp_posts.ID IN ({})");

        add_multiple_if_some_ids!(post__not_in, " AND wp_posts.ID NOT IN ({})");

        if let Some(p_names) = params.post_name__in {
            let q_marks = implode_to_question_mark(&p_names);
            self.query
                .push_str(&format!(" AND wp_posts.post_name IN ({})", q_marks));

            let ids = p_names.into_iter().map(|name| Value::Bytes(name.into()));

            self.values.extend(ids);
        }

        /* Add specific date condition */
        if has_single_date {
            let date = Value::Date(
                params.year.unwrap_or(2023),
                params.monthnum.unwrap_or(1),
                params.day.unwrap_or(1),
                params.hour.unwrap_or(0),
                params.minute.unwrap_or(0),
                params.second.unwrap_or(0),
                0u32,
            );
            self.query.push_str(" AND wp_posts.post_date = ?");
            self.values.push(date);
        }

        /* Add date queries */
        if let Some(date_queries) = params.date_query {
            for dq in date_queries {
                let col = &dq.column;
                if dq.year.is_some() && dq.month.is_some() && dq.day.is_some() {
                    self.query.push_str(&format!(" AND wp_posts.{} = ?", col));
                    self.values.push(dq.to_value());
                }

                let op = dq.relation.to_string();
                if let Some(after) = dq.after {
                    let d_op = if dq.inclusive { ">=" } else { ">" };
                    self.query
                        .push_str(&format!(" {} wp_posts.{} {} ?", &op, col, d_op));
                    self.values.push(after.to_value());
                }

                if let Some(before) = dq.before {
                    let d_op = if dq.inclusive { "<=" } else { "<" };
                    self.query
                        .push_str(&format!(" {} wp_posts.{} {} ?", &op, col, d_op));
                    self.values.push(before.to_value());
                }
            }
        }

        /* Add meta conditions */
        let meta_op = params
            .meta_compare
            .as_ref()
            .unwrap_or(&crate::sql::SqlSearchOperators::Equals)
            .to_string();
        if let Some(meta_k) = params.meta_key {
            self.query
                .push_str(&format!(" AND wp_postmeta.meta_key {} ?", meta_op));
            self.values.push(Value::Bytes(meta_k.into()));
        }

        if let Some(meta_v) = params.meta_value {
            self.query
                .push_str(&format!(" AND wp_postmeta.meta_value {} ?", meta_op));
            self.values.push(Value::Bytes(meta_v.into_bytes()));
        }

        if let Some(meta_v) = params.meta_value_num {
            self.query
                .push_str(&format!(" AND wp_postmeta.meta_value {} ?", meta_op));
            self.values.push(Value::Int(meta_v));
        }

        if let Some(query_rel_map) = params.meta_query {
            for (relation, queries) in query_rel_map {
                self.query.push_str(" AND");
                for (i, query) in queries.into_iter().enumerate() {
                    // Print relation (OR/AND) if more than one query in the group, after first
                    if i > 0 {
                        self.query.push_str(" ");
                        self.query.push_str(relation.to_string().as_str());
                    }

                    // If Exists or NOT EXISTS, we need to make a different query structure
                    match query.compare {
                        op @ (SqlSearchOperators::Exists | SqlSearchOperators::NotExists) => {
                            self.query.push_str(&format!(
                                // Must have AND post_id to ensure that we are not comparing all meta rows for exists/not exist
                                " {} (SELECT * FROM wp_postmeta WHERE meta_key = ? AND wp_postmeta.post_id = wp_posts.ID)",
                                op.to_string()
                            ));
                            // Only push keyname if exists query
                            self.values.push(Value::Bytes(query.key.into_bytes()));
                        }
                        _ => {
                            let op = query.compare.to_string();
                            self.query.push_str(&format!(
                                " (wp_postmeta.meta_value {} ? AND wp_postmeta.meta_key {} ?)",
                                op, op
                            ));
                            self.values.push(Value::Bytes(query.value.into_bytes()));
                            self.values.push(Value::Bytes(query.key.into_bytes()));
                        }
                    };
                }
            }
        }

        /* Add order conditions */
        if let Some(orderby) = params.orderby {
            let order = params.order.unwrap_or(SqlOrder::Desc).clone().to_string();
            self.query
                .push_str(&format!(" ORDER BY {} {}", orderby.to_string(), order))
        }

        /* Add pagination */
        if let Some(page) = params.page {
            let LimitOffsetPair { offset, limit } = sql_paginatorr::for_page(
                page as usize,
                params.posts_per_page.unwrap_or(10) as usize,
            );

            self.query.push_str(" LIMIT ? OFFSET ?;");
            self.values.push(Value::UInt(limit as u64));
            self.values.push(Value::UInt(offset as u64));
        } else {
            let limit = params.posts_per_page.unwrap_or(10);
            self.query.push_str(" LIMIT ?;");
            self.values.push(Value::UInt(limit));
        }

        QueryAndValues(self.query, self.values)
    }
}

fn check_if_term_join_necessary(params: &Params) -> bool {
    params.term_and.is_some()
        || params.term_in.is_some()
        || params.term_not_in.is_some()
        || params.term_slug_and.is_some()
        || params.term_slug_in.is_some()
        || params.tax_query.is_some()
}

fn check_if_meta_join_necessary(params: &Params) -> bool {
    params.meta_key.is_some()
        || params.meta_value.is_some()
        || params.meta_value_num.is_some()
        || params.meta_query.is_some()
}

fn check_if_user_join_necessary(p: &Params) -> bool {
    p.author_name.is_some()
}

fn has_valid_single_date(p: &Params) -> bool {
    p.year.is_some() && p.monthnum.is_some() && p.day.is_some()
}

fn push_post_status(s: &mut String, v: &mut StmtValues, post_status: &PostStatus) {
    if *post_status == PostStatus::Any {
        return;
    }

    s.push_str(" AND post_status = ?");
    v.push(Value::Bytes(post_status.to_string().into_bytes()));
}

fn push_post_type(s: &mut String, v: &mut StmtValues, post_type: Option<Vec<PostType>>) {
    if let Some(post_types) = post_type {
        if post_types.len() == 0 {
            return;
        }

        let q_marks = implode_to_question_mark(&post_types);
        s.push_str(&format!(" AND wp_posts.post_type IN ({})", q_marks));
        for post_type in post_types {
            v.push(Value::Bytes(post_type.into()));
        }
    } else {
        s.push_str(" AND wp_posts.post_type = 'post'");
    }
}

fn implode<T: std::fmt::Display>(v: &[T]) -> String {
    v.iter()
        .map(|n| n.to_string())
        .reduce(|acc, next| format!("{acc},{next}"))
        .unwrap_or(String::new())
}

fn implode_to_question_mark<T>(v: &[T]) -> String {
    let q_marks: Vec<char> = v.iter().map(|_| '?').collect();
    implode(&q_marks)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn ensure_implode_works() {
        let v = vec![1, 2, 3];
        let imploded = implode(&v);
        assert_eq!(&imploded, "1,2,3");
    }

    #[test]
    fn nothing_imploded_for_empty_list() {
        let v: Vec<i32> = vec![];
        let imploded = implode(&v);
        assert_eq!(&imploded, "");
    }

    #[test]
    fn implodes_to_question_marks() {
        let v = vec![1, 2, 3];
        let imploded = implode_to_question_mark(&v);
        assert_eq!(&imploded, "?,?,?");
    }
}