एक बड़ी परियोजना में स्वचालित रिफैक्टिंग

यदि आप एक ही प्रोजेक्ट पर डेवलपर्स की एक बड़ी टीम में काम करते हैं, तो रिफैक्टरिंग करना बहुत मुश्किल काम है। यहाँ एक उदाहरण है: हम do_something () फ़ंक्शन को do_something_with_blackjack () में बदलना चाहते हैं। हमने अपनी शाखा में इस फ़ंक्शन की सभी घटनाओं का नाम बदला और परीक्षण के लिए कार्य भेजा। उसी समय, किसी और ने एक और फ़ंक्शन कॉल जोड़ा, लेकिन पुराने नाम के साथ, इसकी शाखा में भी। अलग-अलग, परिवर्तन सेट काम करेगा, लेकिन विलय के बाद, एक त्रुटि उत्पन्न होती है।

लेख एक ऐसी तकनीक पर विचार करेगा जिसे "स्वचालित रीफैक्टरिंग" कहा जा सकता है - स्व-लिखित लिपियों का उपयोग जो आपके लिए सही काम करते हैं, जिससे आप सभी शाखाओं को मर्ज करने के बाद और सीधे स्टेजिंग / प्रोडक्शन में पोस्ट करने से पहले रिफ्लेक्टर कर सकते हैं।

एक उदाहरण के रूप में phpBB का उपयोग करते हुए, हम दिखाएंगे कि आप SQL क्वेरी को कैसे "रिफ्लेक्टर" कह सकते हैं ताकि वे इनपुट डेटा की स्वचालित स्क्रीनिंग का उपयोग करें (और इस प्रकार SQL इंजेक्शन समस्या को हल करने में मदद करें)।

दृष्टिकोण का विवरण

आइए सिद्धांत से शुरू करें: हम समस्या और इसे हल करने के प्रस्तावित तरीकों का वर्णन करते हैं।

समस्याओं को स्वचालित रूप से बदल जाता है

मान लीजिए कि हम कोड रिफैक्टिंग में लगे हुए हैं और एक फ़ंक्शन (उदाहरणों में, PHP कोड) का नाम बदलना चाहते हैं। मान लें कि हम कोड को निम्नानुसार बदलते हैं (पहला वर्ण "-" का अर्थ है एक पंक्ति को हटाना, और "+" का अर्थ है एक पंक्ति जोड़ना):

<?php -function do_something() +function print_hello() { echo "Hello world!\n"; } $a = 1; -do_something(); +print_hello(); $b = 2; $c = 3; 

जब हम ऐसा कर रहे थे, तो हमारा सहयोगी एक अन्य शाखा में पुराने फ़ंक्शन नाम के उपयोग को जोड़ने में कामयाब रहा:

  <?php function do_something() { echo "Hello world!\n"; } $a = 1; do_something(); $b = 2; +do_something(); $c = 3; 

चूंकि परिवर्तन सुसंगत हैं (हमने कोड की विभिन्न लाइनों के साथ काम किया है), परिवर्तनों के साथ हमारी शाखाओं को स्वचालित रूप से मर्ज करने के बाद, हमें निम्नलिखित कोड मिलते हैं:

 <?php function print_hello() { echo "Hello world!\n"; } $a = 1; print_hello(); $b = 2; do_something(); $c = 3; 

इस प्रकार, अंतिम संस्करण में एक अधिक noxistent फ़ंक्शन (do_something) के लिए कॉल होगा। ऐसा कोड स्पष्ट रूप से काम नहीं करेगा। कुछ लोग "सुविधा शाखाओं" के उपयोग के खिलाफ एक तर्क के रूप में इस तरह के व्यवहार की संभावना का हवाला देते हैं जब वे एक ही कार्य के लिए एक ही शाखा का उपयोग करते हैं। आप इस समस्या के विभिन्न समाधानों की पेशकश कर सकते हैं, लेकिन एक बात स्पष्ट है: यह आसानी से हल नहीं होती है, और आपको एक सक्रिय रूप से विकासशील परियोजना में रिफैक्टिंग की संभावना के लिए महंगा भुगतान करना होगा।

स्वचालित रीफैक्टरिंग

दृष्टिकोण का सार यह है कि हमें कोड में अधिकांश परिवर्तनों के कार्यान्वयन को स्थगित करना चाहिए ताकि सभी शाखाओं के विलय के बाद प्रतिस्थापन हो। यही है, पहले आपको सहकर्मियों द्वारा किए गए परिवर्तनों को लागू करने की आवश्यकता है, और उसके बाद ही अपना काम शुरू करें और अन्य सभी परिवर्तनों के बाद नाम बदलें। आपको एक तंत्र भी शुरू करने की आवश्यकता है जो पुरानी शैली में कोड के उपयोग को प्रतिबंधित करेगा।

इसलिए, रीफैक्टरिंग करने के लिए, आपको निम्नलिखित स्क्रिप्ट लिखने की आवश्यकता है:

• पुराने कोड के उपयोग के लिए जाँच;
• स्वचालित प्रतिस्थापन प्रदर्शन करना;
• पुराने और नए कोड (वैकल्पिक) के उपयोग पर आंकड़ों का संग्रह।

उनमें से प्रत्येक के बारे में अधिक जानकारी।

पुराने कोड के लिए जाँच कर रहा है

रिफैक्टरिंग प्रक्रिया में पुरानी शैली के कोड के उपयोग को रोकने के लिए और इसके पूरा होने के बाद, आपको एक स्क्रिप्ट लिखने की ज़रूरत है जो हमें स्पष्ट रूप से और मज़बूती से स्थापित करने की अनुमति देगी कि कोड का अब उपयोग नहीं किया जाता है। हमारे सरल उदाहरण के लिए, स्क्रिप्ट कुछ इस तरह दिखाई देगी:

 #!/bin/sh grep do_something file.php 

स्क्रिप्ट उस फ़ाइल में लाइनें लौटाती है जिसमें पुराना फ़ंक्शन नाम होता है - do_something।

ऑटो बदलें

हमारे सरल उदाहरण के लिए, Print_hello के साथ do_something की सभी घटनाओं को बदलने के लिए sed पर्याप्त होगा। अधिक जटिल मामलों में, यह पर्याप्त नहीं होगा और अधिक सटीक प्रसंस्करण की आवश्यकता होगी (उदाहरण के लिए, यदि प्रतिस्थापन do_something प्रोजेक्ट में मौजूद हो सकता है और फ़ंक्शन कॉल नहीं हो सकता है)।

 #!/bin/sh sed -i 's/do_something/print_hello/g' file.php 

पुराने और नए कोड के उपयोग पर आंकड़ों का संग्रह

हालाँकि हमारी प्रतिस्थापन स्क्रिप्ट में do_something की सभी घटनाओं को print_hello के साथ प्रतिस्थापित किया जाना चाहिए, यह कुछ भी करने में सक्षम नहीं होगा, उदाहरण के लिए, इस कोड के साथ:

 $func_prefix = "do_"; $func_name = $func_prefix . "something"; // , PHP      ,    $func_name(); 

ऐसी समस्या सी और जावा जैसी सांख्यिकीय रूप से टाइप की गई भाषाओं में भी मौजूद है। C में, आप हमेशा #define लिख सकते हैं और मैक्रोज़ बना सकते हैं, और जावा में एक परावर्तन तंत्र है। ऐसा करने के लिए, हम do_something फ़ंक्शन का नया संस्करण पेश करते हैं (आपको यह सुनिश्चित करने की आवश्यकता है कि यह फ़ंक्शन स्वचालित रूप से उपरोक्त स्क्रिप्ट द्वारा प्रतिस्थापित नहीं किया गया है):

 function do_something() { error_log(__FUNCTION__ . " found. Trace: " . (new Exception())); return print_hello(); } 

नतीजतन, यूनिट परीक्षण करने के बाद या उत्पादन में इस कोड को बिछाने के बाद (यदि आपके पास 100% कवरेज नहीं है), तो आप पुराने फ़ंक्शन के लापता संदर्भ पा सकते हैं। इन टुकड़ों का विश्लेषण किया जा सकता है और इसी प्रतिस्थापन को मैन्युअल रूप से किया जा सकता है।

लिखित लिपियों के उपयोग के चरण

संबंधित स्क्रिप्ट लिखे जाने के बाद, आपको उन्हें सही तरीके से लागू करने की आवश्यकता है। यह इस प्रकार करने का प्रस्ताव है:

1. सभी नवीनतम डेवलपर परिवर्तन मर्ज करें
2. स्वचालित प्रतिस्थापन के लिए स्क्रिप्ट निष्पादित करें और संस्करण नियंत्रण प्रणाली में परिवर्तन करें;
3. जांचें कि पुराने कोड के लिए अधिक संदर्भ नहीं हैं
4. पुराने कोड का उपयोग करके लॉगिंग जोड़ें;
5. इकाई परीक्षण चलाना, उत्पादन कोड रखना;
6. कोड मुख्य विकास शाखा में जाने के तुरंत बाद, आपको अपने संस्करण नियंत्रण प्रणाली के "हुक" को कॉन्फ़िगर करने की आवश्यकता है ताकि यह पुराने कोड के उपयोग को रोक न दे;
7. स्क्रिप्ट में पुराने कोड के उपयोग का सत्यापन जोड़ें जो उत्पादन से पहले कोड को हिट करता है;
8. (वैकल्पिक) उत्पादन से पुराने कोड का उपयोग करके उत्पादन से लॉग एकत्र करने और मैन्युअल रूप से संबंधित स्थानों को ठीक करने के लिए।
9. आपने सफलतापूर्वक रिफलेक्ट किया है!

खंड 7 की उपस्थिति महत्वपूर्ण है, क्योंकि भंडार में अन्य शाखाओं में पुराना कोड हो सकता है जो अभी तक मुख्य विकास शाखा के साथ विलय नहीं हुआ है। ऐसी शाखाओं को विलय करना संघर्षों के बिना जा सकता है, लेकिन उनमें पुराने कोड के संदर्भ हो सकते हैं।

वर्णित तकनीक में एक महत्वपूर्ण बिंदु लिपियों और मैनुअल काम की एक छोटी राशि का उपयोग करके एक साथ परिवर्तन लागू करने की क्षमता है। मैन्युअल रूप से पूरी तरह से मैन्युअल रूप से रिफैक्टरिंग करना भी संभव है, लेकिन अगर आपके पास कोई अन्य विकल्प नहीं है, तो यह एक बहुत ही कठिन तरीका है।

PhpBB में SQL उपयोग को फिर से लाना

वास्तविकता के करीब के उदाहरणों के साथ दृष्टिकोण को समझाने के लिए, हम यह दिखाना चाहेंगे कि SQL इंजेक्शन से जितना संभव हो इसे बचाने के लिए phpBB कोड को कैसे रिफलेक्टर किया जाए:

PhpBB में SQL के साथ काम करें

आइए देखें कि phpBB में SQL के साथ काम कैसे व्यवस्थित किया जाता है और इसका उपयोग क्यों किया जाता है।

सबसे पहले, डेटाबेस कक्षाओं का कार्यान्वयन स्वयं "शामिल / डीबी" में स्थित है, और एक वैश्विक चर $ db "common.php" में बनाया गया है जिसमें डेटाबेस के साथ काम करने के लिए संबंधित वर्ग का एक उदाहरण है।

 $ ls includes/db db_tools.php index.htm mssqlnative.php oracle.php dbal.php mssql.php mysql.php postgres.php firebird.php mssql_odbc.php mysqli.php sqlite.php 

इस प्रकार, "शामिल / डीबी" निर्देशिका को स्वचालित प्रतिस्थापन के दौरान हमारी स्क्रिप्ट से बाहर रखा जाना चाहिए - हम मैन्युअल रूप से संबंधित प्रतिस्थापन का प्रदर्शन करेंगे।

समस्या के पैमाने का आकलन करने के लिए, हम grep नामक एक महान उपकरण का उपयोग करेंगे:

 $ grep -RF 'sql_query(' * | wc -l 1611 

कि sql_query () के लिए लगभग 1,600 कॉल हैं। हमारा मानना ​​है कि यह स्पष्ट हो जाता है कि मैन्युअल रूप से इतनी सारी सीटों की जगह एक अच्छा विचार नहीं है। संभवतः स्थानों की यह संख्या एक कारण है कि phpBB डेवलपर्स ने अभी तक इन कॉलों के साथ कुछ भी नहीं किया है।

आइए अब देखें कि उनके साथ क्या गलत है।

यहाँ sql_query परिभाषा है:

 function sql_query($query = '', $cache_ttl = 0) … 

यहां से हम आसानी से देख सकते हैं कि विधि केवल अनुरोध ही प्राप्त करती है, और कॉलर को स्वतंत्र रूप से मूल्यों की स्क्रीनिंग करनी चाहिए।

Viewtopic.php से उदाहरण:

 $sql = 'SELECT forum_id FROM ' . TOPICS_TABLE . " WHERE topic_id = $topic_id"; $result = $db->sql_query($sql); 

चूँकि $ topic_id बाहर से आता है और ठीक से संभाला नहीं जा सकता, इसलिए SQL त्रुटि और वास्तविक SQL इंजेक्शन दोनों प्राप्त करना संभव है। UNION का उपयोग करने से हम किसी अन्य तालिका से डेटा खींचने की अनुमति भी दे सकते हैं, इसलिए आपको अपनी पूरी शक्ति के साथ ऐसे कोड लिखने से बचना चाहिए।

इसके बजाय, हम निम्नलिखित कुछ लिख सकते हैं:

 $sql = 'SELECT forum_id FROM ' . TOPICS_TABLE . ' WHERE topic_id = ?d'; $result = $db->sql_query_escaped($sql, $topic_id); 

यही है, "$ topic_id" लिखने के बजाय "D?", जिसे sql_query_escaped विधि द्वारा स्वीकार किया जाएगा और हमेशा एक नंबर के रूप में स्पष्ट रूप से संसाधित किया जाएगा।

ऑटो क्वेरी SQL क्वेरी

यह उदाहरण के लिए निम्नलिखित रूप में सबसे सरल आवरण बनाने और dbal.php में रखने के लिए प्रस्तावित है:

 /** * Execute escaped SQL query * * First parameter, $query_template is the SQL template that has the following placeholders: * * ?d - value is integer * ?s - value is string (escaped by default) * ?a - array of integers for usage like IN(?a) * ?r - raw SQL (eg for use in dynamic part of SQL expression) * * Example: * * sql_query_escaped("SELECT * FROM table WHERE table_id = ?d", 42) will be executed as * * SELECT * FROM table WHERE table_id = 42 * * sql_query_escaped("SELECT * FROM table WHERE table_id IN(?a)", array(1, 2, 3)) will be executed as * * SELECT * FROM table WHERE table_id IN(1, 2, 3) * */ function sql_query_escaped($query_template) { $values = func_get_args(); array_shift($values); $regexp = '/\\?[dsar]/s'; preg_match_all($regexp, $query_template, $matches); foreach ($matches[0] as $i => $m) { if ($m == '?d') $values[$i] = intval($values[$i]); else if ($m == '?s') $values[$i] = "'" . $this->sql_escape($values[$i]) . "'"; else if ($m == '?a') $values[$i] = implode(',', array_map('intval', $values[$i])); } $idx = 0; $replace_func = function($placeholder) use ($values, &$idx) { $placeholder = $placeholder[0]; return $values[$idx++]; }; $query = preg_replace_callback($regexp, $replace_func, $query_template); return $this->sql_query($query); } 

कार्यान्वयन और समस्या को हल करने का तरीका हमारे लिए इतना महत्वपूर्ण नहीं है, क्योंकि यह सिर्फ एक उदाहरण है। यदि आप वास्तव में ऐसा कुछ करना चाहते हैं, तो आप बेहतर समाधान के साथ आ सकते हैं या मानक समाधानों का उपयोग कर सकते हैं, जैसे पीडीओ।

डीबग SQL क्वेरीज़

PhpBB में, किसी कारण से, वर्तमान पृष्ठ पर SQL प्रश्नों को प्रदर्शित करने का कोई आसान तरीका नहीं है, इसलिए एक छोटा अस्थायी पैच जोड़ें:

 --- a/includes/db/mysqli.php +++ b/includes/db/mysqli.php @@ -151,6 +151,8 @@ class dbal_mysqli extends dbal return true; } + var $queries = array(); + /** * Base query method * @@ -162,6 +164,7 @@ class dbal_mysqli extends dbal */ function sql_query($query = '', $cache_ttl = 0) { + $this->queries[] = $query; if ($query != '') { global $cache; --- a/includes/functions.php +++ b/includes/functions.php @@ -4735,6 +4735,10 @@ function page_footer($run_cron = true) } $debug_output .= ' | <a href="' . build_url() . '&explain=1">Explain</a>'; + + foreach ($db->queries as $query) { + $debug_output .= "<pre style='text-align: left; margin-bottom: 10px;'>" . htmlspecialchars($query) . "</pre>\n<hr/>\n"; + } } } 

Sql_query () का उपयोग करने का विश्लेषण

सबसे महत्वपूर्ण बिंदुओं में से एक जब स्वचालित रीफैक्टरिंग के लिए स्क्रिप्ट लिखना तथाकथित "टकटकी विधि" है। हमें यह देखने की आवश्यकता है कि जिस पद्धति को हम बदलने जा रहे हैं उसका उपयोग कैसे किया जाता है, और कोड को ध्यान से देखकर इसके उपयोग के मुख्य पैटर्न को खोजें।

तो, हम फिर से grep का उपयोग करेंगे, लेकिन इस बार हम sql_query () के उल्लेख की आंखों से देखेंगे और पाए गए मुख्य पैटर्न तैयार करने का प्रयास करेंगे:

 $ grep -RF 'sql_query(' * | less 

मुख्य पैटर्न:

1. $ परिणाम = $ db-> sql_query ($ sql); // $ sql चर में क्वेरी पाठ होता है;
2. $ db-> sql_query ("DELETE | UPDATE | SELECT ..."); // अनुरोध स्पष्ट रूप से निर्दिष्ट किया गया है।

आप यह भी देख सकते हैं कि एक ही नाम हमेशा डेटाबेस ऑब्जेक्ट के लिए उपयोग किया जाता है - "$ db"। हालाँकि, आपको यह सुनिश्चित करना होगा कि डेटाबेस ऑब्जेक्ट का उपयोग किसी अन्य नाम के तहत नहीं किया गया है और अन्य वर्गों में कोई sql_query विधि नहीं है:

 $ grep -RF 'sql_query(' * | grep -vF '$db->sql_query(' 

इस कोड को निष्पादित करके, हम देखेंगे कि अभी भी संदर्भ हैं। उन्हें कई श्रेणियों में विभाजित किया जा सकता है:

• डॉक्स / *। html - छोड़ें क्योंकि यह प्रलेखन है;
• शामिल / db / db_tools.php - वर्ग में sql_table_exists, sql_alter_table और अन्य DDL विधियाँ शामिल हैं;
• शामिल हैं / db / dbal.php: sql_query_limit विधि में उपयोग किया जाता है, साथ ही सम्मिलित विधियों में, जो स्वयं मूल्यों को ढाल देते हैं;
• शामिल हैं / db / (mysql | mssql, firebird | ...)। php - mysql_query, mssql_query, आदि को कॉल करता है;
• शामिल हैं / functions_convert.php - डेटाबेस को परिवर्तित करने के लिए कार्य (phpBB के एक संस्करण से दूसरे में);
• डेटाबेस बदलने के लिए / कन्वर्टर्स / कन्वर्ट _ *। php - स्क्रिप्ट;
• install / install_convert.php डेटाबेस को बदलने के लिए एक स्क्रिप्ट भी है।

इस सब से, हमें वास्तव में dal heirs में sql_query () कॉल के साथ-साथ dbal में भी ध्यान देना चाहिए। इस प्रकार, हमारे अतिरिक्त विश्लेषण से, यह स्पष्ट हो गया कि हमें sql_query_limit के सभी कॉलों को रिफलेक्टर करने की आवश्यकता है।

डेटाबेस रूपांतरण के लिए सैद्धांतिक रूप से SQL इंजेक्शन भी हो सकते हैं। हालाँकि, ये स्क्रिप्ट सभी SQL क्वेरी का एक छोटा हिस्सा बनाती हैं और सबसे अधिक संभावना है कि उनकी बारीकियों के कारण SQL इंजेक्शन शामिल नहीं हैं। इसलिए, हम इन स्थानों को छोड़ देंगे।

पार्सिंग $ db-> sql_query ('चयन / अद्यतन / वितरण ...')

आइए अब एक स्क्रिप्ट लिखें जो SQL क्वेरी सीधे लिखे जाने पर हमें sql_query के सभी संदर्भों को खोजेगी। Sql_query ($ sql) की तुलना में बहुत अधिक ऐसे स्थान नहीं हैं, लेकिन एक शुरुआत के लिए हम एक सरल कार्य का चयन करेंगे।

एल्गोरिथ्म निम्नानुसार है: हम फ़ाइलों की सामग्री को टोकन में तोड़ते हैं और अनुक्रम "$ db", "->", और "sql_query" को ढूंढते हैं। उसके बाद, कोष्ठक में अभिव्यक्ति समान क्वेरी होगी। टोकनर एक्सटेंशन का उपयोग करके कोड PHP 5.3 में लिखा जाएगा।

 <?php //        ,    : $files = exec('grep -RF \'$db->sql_query(\' * | awk -F: \'{print $1;}\'', $out, $retval); if ($retval) exit(1); //       replacer/ $excludes = array('includes/db/', 'replacer/'); $num_lines = 0; foreach (array_unique($out) as $filename) { foreach ($excludes as $excl) { if (strpos($filename, $excl) === 0) continue(2); } $contents = file_get_contents($filename); if ($contents === false) exit(1); $lines = explode("\n", $contents); //       $tokens = token_get_all($contents); $num = count($tokens); $line = 1; $type = $text = ''; //    5   : '$db', '->', 'sql_query', '('    //         «» $accepted_value_types = array(T_CONSTANT_ENCAPSED_STRING, T_ENCAPSED_AND_WHITESPACE, '"'); foreach ($tokens as $cur_idx => $tok) { parse_token($tok, $type, $text, $line); //     ,       5  if ($cur_idx >= $num - 5) continue; $ln = $line; $i = $cur_idx + 1; //      (http://php.net/manual/tokens.php) if ($type !== T_VARIABLE || $text !== '$db') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== T_OBJECT_OPERATOR || $text !== '->') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== T_STRING || $text !== 'sql_query') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== '(') continue; parse_token($tokens[$i++], $type, $text, $ln); if (!in_array($type, $accepted_value_types, true)) continue; //    :   ,      $depth = 1; $query = ''; for ($i = $i - 1; $i < $num; $i++) { parse_token($tokens[$i], $type, $text, $ln); if ($type === '(') $depth++; else if ($type === ')') $depth--; if ($depth == 0) break; $query .= $text; } $query = preg_replace(array("/[\t ]+/s", '/^/m'), array(' ', ' '), $query); $results[$filename][] = $query; $num_lines++; } } foreach ($results as $filename => $list) { echo "$filename\n"; foreach ($list as $row) echo "$row\n"; echo "\n"; } echo "Total lines recognized: $num_lines\n"; // .       token_get_all function parse_token($tok, &$type, &$text, &$line) { if (is_array($tok)) list($type, $text, $line) = $tok; else $type = $text = $tok; } 

शुरू करने के बाद, हम देखेंगे कि हमारी स्क्रिप्ट ने लगभग 130 लाइनों को मान्यता दी है, जो परियोजना में "sql_query" की सभी पाठ्य प्रविष्टियों का लगभग 8% है। आप यह भी देख सकते हैं कि पाया लाइनों का एक महत्वपूर्ण हिस्सा फार्म की लाइनें हैं

 includes/acp/acp_attachments.php 'INSERT INTO ' . EXTENSIONS_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary) includes/acp/acp_bbcodes.php 'INSERT INTO ' . BBCODES_TABLE . $db->sql_build_array('INSERT', $sql_ary) 

यही है, sql_build_array विधि का उपयोग खेतों में मान डालने के लिए किया जाता है, और इस पद्धति के मान पहले से ही बच गए हैं और आप यहां कुछ भी नहीं छू सकते हैं।

पार्सिंग $ db-> sql_query ($ sql)

अब आइए जानें कि एसक्यूएल क्वेरी का पाठ कैसे प्राप्त किया जाए जब मामले में इसका मूल्य $ sql चर से लिया जाए। आइए अनुरोध कॉल के संदर्भ को देखें और स्वयं अनुरोध प्राप्त करने का एक तरीका खोजने का प्रयास करें:

 $ grep -A 5 -B 5 -RF '$db->sql_query($sql' * | less 

कोड से आप देख सकते हैं कि अधिकांश अनुरोध निम्नानुसार हैं:

 $sql = '...'; //   $db->sql_query($sql); 

दूसरे शब्दों में, $ sql चर की परिभाषा और मान का असाइनमेंट sql_query () कॉल से ठीक पहले होता है। इसलिए, हम ऐसे मामले के प्रसंस्करण को सबसे आम और सरल लिखेंगे। सबसे पहले, हम प्रश्नों के साथ लाइनों को प्रिंट करते हैं ताकि यह स्पष्ट हो सके कि हम किसके साथ काम कर रहे हैं:

 <?php //        ,     $files = exec('grep -RF \'$db->sql_query($sql\' * | awk -F: \'{print $1;}\'', $out, $retval); if ($retval) exit(1); //       replacer/ $excludes = array('includes/db/', 'replacer/'); $num_lines = 0; foreach (array_unique($out) as $filename) { foreach ($excludes as $excl) { if (strpos($filename, $excl) === 0) continue(2); } echo "$filename\n"; $contents = file_get_contents($filename); if ($contents === false) exit(1); $lines = explode("\n", $contents); //       $tokens = token_get_all($contents); $num = count($tokens); $line = 1; $type = $text = ''; //    5   : '$db', '->', 'sql_query', '('  '$sql' foreach ($tokens as $cur_idx => $tok) { parse_token($tok, $type, $text, $line); //     ,       5  if ($cur_idx >= $num - 5) continue; $ln = $line; $i = $cur_idx + 1; //      (http://php.net/manual/tokens.php) if ($type !== T_VARIABLE || $text !== '$db') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== T_OBJECT_OPERATOR || $text !== '->') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== T_STRING || $text !== 'sql_query') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== '(') continue; parse_token($tokens[$i++], $type, $text, $ln); if ($type !== T_VARIABLE || $text !== '$sql') continue; //     .     grep printf("%6d %s\n", $line, ltrim($lines[$line - 1])); $positions = find_dollar_sql_assignment($tokens, $cur_idx); if (!is_array($positions)) { echo " $positions\n\n"; continue; } $query = ''; for ($i = $positions['begin']; $i <= $positions['end']; $i++) { parse_token($tokens[$i], $type, $text, $ln); $query .= $text; } $query = preg_replace(array("/[\t ]+/s", '/^/m'), array(' ', ' '), $query); echo "\n" . $query . "\n\n"; $num_lines++; } echo "\n"; } echo "Total lines recognized: $num_lines\n"; // .       token_get_all function parse_token($tok, &$type, &$text, &$line) { if (is_array($tok)) list($type, $text, $line) = $tok; else $type = $text = $tok; } //  $sql = '...';  $db->sql_query($sql function find_dollar_sql_assignment($tokens, $db_idx) { $depth = 0; $line = 1; $type = $text = ''; //        $sql for ($idx = $db_idx - 1; $idx > 0; $idx--) { parse_token($tokens[$idx], $type, $text, $line); //    if ($type === ')') $depth++; else if ($type === '(') $depth--; if ($depth < 0) { return "depth < 0 on line " . __LINE__; } /*         ,      : if (...) { $sql = 'SELECT * FROM Table1 WHERE user_id = $user_id'; } else { $sql = 'SELECT * FROM Table2'; } $result = $db->sql_query($sql); */ if ($type === '{' || $type === '}') { return "open/close brace found on line " . __LINE__; } if ($type === T_VARIABLE && $text === '$sql') { $i = $idx + 1; parse_token($tokens[$i++], $type, $text, $line); if ($type === T_WHITESPACE) parse_token($tokens[$i++], $type, $text, $line); if ($type !== '=') continue; //   "$sql = " ! $begin_pos = $i; break; } } //      «$sql = »,     //  ,        «;» $depth = 0; for ($idx = $begin_pos; $idx < $db_idx; $idx++) { parse_token($tokens[$idx], $type, $text, $line); if ($type === '(') $depth++; else if ($type === ')') $depth--; if ($depth < 0) { return "depth < 0 on line " . __LINE__; } if ($depth === 0 && $type === ';') { return array('begin' => $begin_pos, 'end' => $idx - 1); } } //   ,       $db->sql_query  «;» //  ,     return "Statement does not terminate on line " . __LINE__; } 

प्रत्यक्ष क्वेरी आउटपुट के अलावा, हम अंत में मान्यता प्राप्त लाइनों की संख्या (लगभग 1150) पर भी आउटपुट करते हैं। यह सभी sql_query पाठ्य-प्रविष्टियों का लगभग 70% है! आइए अब हमारी स्क्रिप्ट के आउटपुट के उदाहरण देते हैं:

 cron.php 59 $db->sql_query($sql); 'UPDATE ' . CONFIG_TABLE . " SET config_value = '" . $db->sql_escape(CRON_ID) . "' WHERE config_name = 'cron_lock' AND config_value = '" . $db->sql_escape($config['cron_lock']) . "'" … includes/acp/acp_forums.php 243 $result = $db->sql_query($sql); 'SELECT * FROM ' . FORUMS_TABLE . " WHERE forum_id = $forum_id" ... 1096 $db->sql_query($sql); 'DELETE FROM ' . FORUMS_TABLE . ' WHERE ' . $db->sql_in_set('forum_id', $forum_ids) includes/acp/acp_reasons.php ... 96 $result = $db->sql_query($sql); 'SELECT reason_id FROM ' . REPORTS_REASONS_TABLE . " WHERE reason_title = '" . $db->sql_escape($reason_row['reason_title']) . "'" ... includes/acp/acp_search.php 320 $result = $db->sql_query($sql); 'SELECT post_id, poster_id, forum_id FROM ' . POSTS_TABLE . ' WHERE post_id >= ' . (int) ($post_counter + 1) . ' AND post_id <= ' . (int) ($post_counter + $this->batch_size) 

विधियों के प्रत्यक्ष उपयोग पर ध्यान दें $ db-> sql_escape और $ db-> sql_in_set: हमें ऐसे तरीकों की कॉल को अलग से संभालना चाहिए और प्रत्यक्ष कोड में भागने की उपस्थिति को ध्यान में रखना चाहिए। इसके अलावा, इस कोड को फिर से लिखने पर इंटैल () और इंट को टाइप करने के लिए कॉल भी विचार करने योग्य हैं।

क्वेरी पाठ रूपांतरण

अब जब हमने सीखा है कि क्वेरी के पाठ को कैसे निकालना है, यह एक इनपुट के रूप में क्वेरी के अनुरूप टोकन की एक सरणी को स्वीकार करने की क्षमता के साथ एक फ़ंक्शन लिखने का समय है, और टोकन की एक और सरणी लौटाएं, जिसमें sql.query_escaped के लिए क्वेरी टेम्पलेट शामिल है, साथ ही इसके लिए एक तर्क भी दिया जाएगा। विधि। दूसरे शब्दों में, हम निम्नलिखित चाहते हैं:

 $sql = /*    */ 'SELECT user_id, author_id FROM ' . PRIVMSGS_TO_TABLE . ' WHERE msg_id = ' . $attachment['post_msg_id'] /*   */; $result = $db->sql_query($sql); //     $sql = 'SELECT user_id, author_id FROM ' . PRIVMSGS_TO_TABLE . ' WHERE msg_id = ?d'; $result = $db->sql_query_escaped($sql, $attachment['post_msg_id']); 

«?d», , , «_id», . , , «» .

, , . , , . '?r', sql_query() , sql_query_escaped(), .

 function rewrite_tokens($in_tokens) { static $string_types = array(T_CONSTANT_ENCAPSED_STRING, T_ENCAPSED_AND_WHITESPACE, '"'); $type = $text = null; $line = 1; //   ,     ,  ,  ,  : // ($action == 'add') ? 'INSERT INTO ' . EXTENSION_GROUPS_TABLE . ' ' : 'UPDATE ' . EXTENSION_GROUPS_TABLE . ' SET ' parse_token($in_tokens[0], $type, $text, $line); if ($type === T_WHITESPACE) parse_token($in_tokens[1], $type, $text, $line); if (!in_array($type, $string_types, true)) return "Expected first token to be string (got $type)"; $out_params = $out_tokens = array(); //    ,     : // // 'SELECT * FROM ' . TABLE_SOMETHING . ' WHERE lang_id = ' . intval($lang_id) // //    // // array(array('SELECT * FROM ', TABLE_SOMETHING), array(' WHERE lang_id = ', intval($lang_id))) // // ,       ,      $state = 'begin'; $left_tokens = $right_tokens = $groups = array(); $depth = 0; //   foreach ($in_tokens as $tok) { parse_token($tok, $type, $text, $line); if ($type === '(') $depth++; else if ($type === ')') $depth--; if ($depth < 0) return "Brace depth less than zero"; if ($state == 'begin') { //    «» ,      if ($depth > 0 || $type !== '.') { $left_tokens[] = $tok; } else { $state = 'end'; } } else { //   ,          $groups if ($depth > 0 || $type !== '.') { $right_tokens[] = $tok; } else { $state = 'begin'; $groups[] = array($left_tokens, $right_tokens); $left_tokens = $right_tokens = array(); } } } //   -  ,     if (count($left_tokens)) $groups[] = array($left_tokens, $right_tokens); foreach ($groups as $grp) { list($left_tokens, $right_tokens) = $grp; //    ,        parse_token($left_tokens[0], $type, $text, $line); if ($type === T_WHITESPACE) parse_token($left_tokens[1], $type, $text, $line); if (!in_array($type, $string_types, true)) return "first token in a group is not string"; //   ,     foreach ($left_tokens as $tok) { parse_token($left_tokens[0], $type, $text, $line); $out_tokens[] = $tok; } if (!count($right_tokens)) break; $out_tokens[] = '.'; //   -    *_TABLE,  ,   $param = tokens_to_string($right_tokens); if (preg_match('/^\\s*([A-Z0-9_]+)_TABLE\\s*$/s', $param)) { foreach ($right_tokens as $tok) $out_tokens[] = $tok; } else { //    '?r', «»  $out_tokens[] = array(T_CONSTANT_ENCAPSED_STRING, "'?r'", $line); $out_params[] = $param; } $out_tokens[] = '.'; } //       , //  ,    syntax error parse_token(end($out_tokens), $type, $text, $line); if ($type === '.') array_pop($out_tokens); return array( 'tokens' => $out_tokens, 'params' => $out_params, ); } function tokens_to_string($tokens) { $str = ''; $type = $text = null; $line = 1; foreach ($tokens as $tok) { parse_token($tok, $type, $text, $line); $str .= $text; } $str = preg_replace(array("/[\t ]+/s", '/^/m'), array(' ', ' '), $str); return $str; } 

, ( cron.php):

 $sql = 'UPDATE ' . CONFIG_TABLE . " SET config_value = '" .'?r'. "' WHERE config_name = 'cron_lock' AND config_value = '" .'?r'. "'"; $db->sql_query_escaped($sql, $db->sql_escape(CRON_ID), $db->sql_escape($config['cron_lock'])); 

:

  $sql = 'UPDATE ' . CONFIG_TABLE . " - SET config_value = '" . $db->sql_escape(CRON_ID) . "' - WHERE config_name = 'cron_lock' AND config_value = '" . $db->sql_escape($config['cron_lock']) . "'"; -$db->sql_query($sql); + SET config_value = '" .'?r'. "' + WHERE config_name = 'cron_lock' AND config_value = '" .'?r'. "'"; +$db->sql_query_escaped($sql, $db->sql_escape(CRON_ID), $db->sql_escape($config['cron_lock'])); 

, $sql:

 - $db->sql_query('UPDATE ' . CONFIG_TABLE . ' SET config_value = ' . $sql_update . " WHERE config_name = '" . $db->sql_escape($config_name) . "'"); + $db->sql_query_escaped('UPDATE ' . CONFIG_TABLE . ' SET config_value = ' .'?r'. " WHERE config_name = '" .'?r'. "'", $sql_update, $db->sql_escape($config_name)); 

- '?r', . ( «WHERE id = $forum_id»). , «» . , .

, :

 $ grep -RF 'sql_query(' * | wc -l 335 

, 80% . 20% , , 80% , .

,

, «» . , , :

• sql_query_escaped sql_query;
• "?r";
• ;
• , «» SQL.

"?r", :

• , SQL-, ;
• — , «?d»;
• "... '?r' ..." , "... ?s ..." ;
• SQL, .

replacer/direct_sql.php — SQL sql_query()
replacer/sql_assignment.php — sql_query($sql)
replacer/rewrite.php — SQL