]> git.mxchange.org Git - hub.git/commitdiff
todo-builder.sh and TODOs.txt added
authorRoland Häder <roland@mxchange.org>
Fri, 14 Aug 2009 23:53:18 +0000 (23:53 +0000)
committerRoland Häder <roland@mxchange.org>
Fri, 14 Aug 2009 23:53:18 +0000 (23:53 +0000)
.gitattributes
docs/TODOs.txt [new file with mode: 0644]
todo-builder.sh [new file with mode: 0755]

index 83bf2e2b3b7fa0f9e8bc546957129b0b19fafb56..77998c9f0cf181ae22007a3b79452e27284145d0 100644 (file)
@@ -225,7 +225,9 @@ docs/COPYING.software -text
 docs/NEWS -text
 docs/README -text
 docs/THANKS -text
+docs/TODOs.txt -text
 /index.php -text
 /package.sh -text
 /pdepend.sh -text
 /rebuild_doc.sh -text
+/todo-builder.sh -text
diff --git a/docs/TODOs.txt b/docs/TODOs.txt
new file mode 100644 (file)
index 0000000..4792c92
--- /dev/null
@@ -0,0 +1,147 @@
+### WARNING: THIS FILE IS AUTO-GENERATED BY ./todo-builder.sh ###
+### DO NOT EDIT THIS FILE. ###
+./application/hub/interfaces/nodes/class_NodeHelper.php:10: * @todo            We need to find a better name for this interface
+./application/hub/interfaces/pool/client/class_PoolableClient.php:30:   * @todo        0% done
+./application/hub/main/commands/console/class_HubConsoleMainCommand.php:108:    * @todo        Should we add some more filters?
+./application/hub/main/commands/console/class_HubConsoleMainCommand.php:91:                    // @TODO We may have to catch some exceptions here
+./application/hub/main/filter/node/class_NodeInitializationFilter.php:54:       * @todo        0% done
+./application/hub/main/filter/node/class_NodeInitializationFilter.php:87:                      // @TODO Can we rewrite this to app_die() ?
+./application/hub/main/filter/shutdown/class_HubShutdownDeinitQueuesFilter.php:55:      * @todo        0% done
+./application/hub/main/filter/shutdown/class_HubShutdownFlushNodeListFilter.php:55:     * @todo        0% done
+./application/hub/main/filter/shutdown/class_HubShutdownListenerPoolFilter.php:55:      * @todo        0% done
+./application/hub/main/filter/task/class_TaskHandlerInitializerFilter.php:55:   * @todo        0% done
+./application/hub/main/handler/network/tcp/class_TcpNetworkPackageHandler.php:61:       * @todo        0%
+./application/hub/main/handler/network/udp/class_UdpNetworkPackageHandler.php:55:       * @todo        0%
+./application/hub/main/iterator/network/class_NetworkListenIterator.php:10: * @todo            This current implementation is not recommended, use a
+./application/hub/main/iterator/network/class_NetworkListenIterator.php:11: * @todo            latency-based iteration or similar approaches
+./application/hub/main/iterator/pool/handler/class_HandlerPoolIterator.php:10: * @todo         This current implementation is not recommended, use a
+./application/hub/main/iterator/pool/handler/class_HandlerPoolIterator.php:11: * @todo         latency-based iteration or similar approaches
+./application/hub/main/listener/tcp/class_TcpListener.php:160:  * @todo        0% done
+./application/hub/main/listener/udp/class_UdpListener.php:61:   * @todo        stream_socket_server() was declared slow by some user comments.
+./application/hub/main/listener/udp/class_UdpListener.php:62:   * @todo        Please rewrite it to socket_create() and its brothers.
+./application/hub/main/listener/udp/class_UdpListener.php:85:   * @todo        0% done
+./application/hub/main/lists/class_BaseList.php:233:                   // @TODO Extend this somehow?
+./application/hub/main/nodes/boot/class_HubBootNode.php:113:    * @todo        0%
+./application/hub/main/nodes/boot/class_HubBootNode.php:58:     * @todo        add some more special bootstrap things for this boot node
+./application/hub/main/nodes/boot/class_HubBootNode.php:99:     * @todo        Unfinished method
+./application/hub/main/nodes/class_BaseHubNode.php:348:         * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
+./application/hub/main/nodes/class_BaseHubNode.php:500:                // @TODO Add some criteria, e.g. if the node is active or so
+./application/hub/main/nodes/list/class_HubListNode.php:58:     * @todo        Implement this method
+./application/hub/main/nodes/list/class_HubListNode.php:68:     * @todo        Unfinished method
+./application/hub/main/nodes/list/class_HubListNode.php:82:     * @todo        0%
+./application/hub/main/nodes/master/class_HubMasterNode.php:58:         * @todo        Implement this method
+./application/hub/main/nodes/master/class_HubMasterNode.php:68:         * @todo        Unfinished method
+./application/hub/main/nodes/master/class_HubMasterNode.php:82:         * @todo        0%
+./application/hub/main/nodes/regular/class_HubRegularNode.php:58:       * @todo        Implement this method
+./application/hub/main/nodes/regular/class_HubRegularNode.php:68:       * @todo        Unfinished method
+./application/hub/main/nodes/regular/class_HubRegularNode.php:82:       * @todo        0%
+./application/hub/main/resolver/state/network/class_NetworkStateResolver.php:69:        * @todo        0%
+./application/hub/main/visitor/pool/handler/class_HandlerListenerPoolVisitor.php:56:    * @todo        Find some use of doListen() method in listener pool classes
+./application/hub/main/visitor/pool/handler/class_HandlerListenerPoolVisitor.php:69:    * @todo        Find some use of doListen() method in listener decorator classes
+./inc/classes/exceptions/io/class_FileNotFoundException.php:10: * @todo                Rename this class to FileIoException
+./inc/classes/exceptions/main/class_ClassNotFoundException.php:10: * @todo             Rename this class to NoClassException
+./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:10: * @todo               Rename this class to NoFoundEntryException
+./inc/classes/exceptions/main/class_ExceptionNotFoundException.php:10: * @todo         Is this exception still needed???
+./inc/classes/exceptions/main/class_GetterNotFoundException.php:10: * @todo            This class is no longer needed!
+./inc/classes/exceptions/main/class_NoArrayCreatedException.php:10: * @todo            This class is no longer needed
+./inc/classes/exceptions/main/class_NoArrayException.php:10: * @todo           Is this exception still needed?
+./inc/classes/interfaces/class_FrameworkInterface.php:11: * @todo              Find a better name for this interface
+./inc/classes/main/class_BaseFrameworkSystem.php:1040:  * @todo        Write a logging mechanism for productive mode
+./inc/classes/main/class_BaseFrameworkSystem.php:1054:                 // @TODO Finish this part!
+./inc/classes/main/class_BaseFrameworkSystem.php:185:   * @todo        This is old code. Do we still need this old lost code?
+./inc/classes/main/class_BaseFrameworkSystem.php:253:   * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
+./inc/classes/main/commands/web/class_WebLoginAreaCommand.php:64:       * @todo        Add some stuff here: Some personal data, app/game related data
+./inc/classes/main/console/class_ConsoleTools.php:41:   * @todo        We should connect this to a caching class to cache DNS requests
+./inc/classes/main/console/class_ConsoleTools.php:54:          // @TODO Here should the cacher be implemented
+./inc/classes/main/controller/console/class_ConsoleDefaultController.php:10: * @todo           This controller shall still provide some headlines for sidebars
+./inc/classes/main/controller/login/class_WebLoginAreaController.php:40:        * @todo        Add some morer filters to this controller
+./inc/classes/main/controller/web/class_WebConfirmController.php:40:    * @todo        Add some filters to this controller
+./inc/classes/main/controller/web/class_WebDefaultController.php:10: * @todo           This controller shall still provide some headlines for sidebars
+./inc/classes/main/controller/web/class_WebLoginController.php:41:      * @todo        Add some filters to this controller
+./inc/classes/main/controller/web/class_WebLogoutController.php:10: * @todo            This controller shall still provide some headlines for sidebars
+./inc/classes/main/controller/web/class_WebLogoutDoneController.php:40:         * @todo        Add some filters to this controller
+./inc/classes/main/controller/web/class_WebRegisterController.php:40:   * @todo        Add some filters to this controller
+./inc/classes/main/controller/web/class_WebStatusController.php:10: * @todo            This controller shall still provide some headlines for sidebars
+./inc/classes/main/criteria/search/class_SearchCriteria.php:114:        * @todo        Find a nice casting here. (int) allows until and including 32766.
+./inc/classes/main/criteria/search/class_SearchCriteria.php:94:         * @todo        Find a nice casting here. (int) allows until and including 32766.
+./inc/classes/main/database/databases/class_LocalFileDatabase.php:363:  * @todo        Do some checks on the database directory and files here
+./inc/classes/main/discovery/payment/class_LocalPaymentDiscovery.php:82:        * @todo        0% done
+./inc/classes/main/filter/change/class_EmailChangeFilter.php:54:        * @todo        Implement email change of the user here. HINT: Use the User class!
+./inc/classes/main/filter/change/class_PasswordChangeFilter.php:55:     * @todo        Finished updating user password hash here. HINT: Use the User class again.
+./inc/classes/main/filter/news/class_NewsProcessFilter.php:55:  * @todo        Unfinished stub, add functionality here
+./inc/classes/main/filter/payment/class_PaymentDiscoveryFilter.php:97:  * @todo        0% done
+./inc/classes/main/filter/update/class_UserUpdateFilter.php:55:         * @todo        Add more user updates here
+./inc/classes/main/filter/verifier/class_AccountPasswordVerifierFilter.php:57:  * @todo        Rewrite handling of different password fields
+./inc/classes/main/helper/class_BaseHelper.php:171:     * @todo        Rewrite this method using a helper class for filtering data
+./inc/classes/main/helper/web/class_BaseWebHelper.php:151:      * @todo        Implement check if rules have been changed
+./inc/classes/main/helper/web/forms/class_WebFormHelper.php:102:        * @todo        Add some unique PIN here to bypass problems with some browser and/or extensions
+./inc/classes/main/helper/web/forms/class_WebFormHelper.php:621:        * @todo        Add checking if sub option is already added
+./inc/classes/main/helper/web/forms/class_WebFormHelper.php:649:        * @todo        Add checking if sub option is already added
+./inc/classes/main/helper/web/links/class_WebLinkHelper.php:184:        * @todo        Completely unimplemented
+./inc/classes/main/images/class_BaseImage.php:156:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:166:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:176:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:186:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:196:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:215:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:234:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:245:      * @todo        Find something usefull for this method.
+./inc/classes/main/images/class_BaseImage.php:255:      * @todo        Find something usefull for this method.
+./inc/classes/main/io/class_FileIoStream.php:74:        * @todo        This method needs heavy rewrite
+./inc/classes/main/mailer/debug/class_DebugMailer.php:124:      * @todo        0% done
+./inc/classes/main/output/class_ConsoleOutput.php:61:          // @TODO Need to rewrite this to $requestInstance->addHeader()
+./inc/classes/main/output/class_WebOutput.php:55:                      // @TODO Need to rewrite this to $requestInstance->addHeader()
+./inc/classes/main/points/class_UserPoints.php:103:                    // @TODO Load points here
+./inc/classes/main/points/class_UserPoints.php:81:      * @todo        Finish loading part of points
+./inc/classes/main/request/console/class_ConsoleRequest.php:115:               // @TODO There are no cookies on console
+./inc/classes/main/request/console/class_ConsoleRequest.php:55:         * @todo        Needs to be implemented
+./inc/classes/main/resolver/controller/class_BaseControllerResolver.php:137:                   // @TODO Maybe we need to log this?
+./inc/classes/main/response/http/class_HttpResponse.php:77:     * @todo        Encryption of cookie data not yet supported.
+./inc/classes/main/response/http/class_HttpResponse.php:78:     * @todo        Why are these parameters conflicting?
+./inc/classes/main/response/http/class_HttpResponse.php:79:     * @todo        If the return statement is removed and setcookie() commented out,
+./inc/classes/main/response/http/class_HttpResponse.php:80:     * @todo        this will send only one cookie out, the first one.
+./inc/classes/main/response/image/class_ImageResponse.php:93:   * @todo        Encryption of cookie data not yet supported.
+./inc/classes/main/response/image/class_ImageResponse.php:94:   * @todo        Why are these parameters conflicting?
+./inc/classes/main/response/image/class_ImageResponse.php:95:   * @todo        If the return statement is removed and setcookie() commented out,
+./inc/classes/main/response/image/class_ImageResponse.php:96:   * @todo        this will send only one cookie out, the first one.
+./inc/classes/main/result/class_DatabaseResult.php:226:         * @todo        0% done
+./inc/classes/main/result/class_DatabaseResult.php:379:4        * @todo        Find a caching way without modifying the result array
+./inc/classes/main/rng/class_RandomNumberGenerator.php:150:     * @todo        I had a better random number generator here but now it is somewhere lost :(
+./inc/classes/main/rng/class_RandomNumberGenerator.php:83:      * @todo        Add site key for stronger salt!
+./inc/classes/main/template/class_BaseTemplateEngine.php:1303:                 // @TODO We need to find a fallback solution here
+./inc/classes/main/template/class_BaseTemplateEngine.php:810:   * @todo        Unfinished work or don't die here.
+./inc/classes/main/template/class_BaseTemplateEngine.php:827:                          // @TODO Non-string found so we need some deeper analysis...
+./inc/classes/main/template/class_BaseTemplateEngine.php:904:                  // @TODO Old behaviour, will become obsolete!
+./inc/classes/main/template/class_BaseTemplateEngine.php:907:                  // @TODO Yet another old way
+./inc/classes/main/template/class_BaseTemplateEngine.php:981:   * @todo        Make this code some nicer...
+./inc/classes/main/template/image/class_ImageTemplateEngine.php:229:    * @todo        Find something usefull with this!
+./inc/classes/main/template/image/class_ImageTemplateEngine.php:249:    * @todo        Add cache creation here
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:234:      * @todo        Add cache creation here
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:244:      * @todo        Should we call back the mailer class here?
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:325:      * @todo        0% done
+./inc/classes/main/user/class_BaseUser.php:305:         * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
+./inc/classes/main/user/class_BaseUser.php:80:  * @todo        Find a way of casting here. "(int)" might destroy the user id > 32766
+./inc/classes/main/user/member/class_Member.php:84:     * @todo        Add more ways over creating user classes
+./inc/classes/middleware/debug/class_DebugMiddleware.php:112:                  // @TODO Initialization phase
+./inc/config/class_FrameworkConfiguration.php:205:      * @todo        We have to add some more entries from $_SERVER here
+./inc/database.php:49:// @TODO Rewrite this
+./inc/hooks.php:26:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
+./inc/includes.php:36:// @TODO Find a nicer OOP-ed way for this
+./inc/language.php:31:// @TODO Rewrite this
+./inc/loader/class_ClassLoader.php:262:                        /* @todo: Do not die here. */
+### ### DEPRECATION FOLLOWS: ### ###
+./inc/classes/exceptions/container/class_ContainerItemIsNoArrayException.php:10: * @deprecated
+./inc/classes/exceptions/container/class_ContainerItemIsNullException.php:10: * @deprecated
+./inc/classes/exceptions/container/class_ContainerMaybeDamagedException.php:10: * @deprecated
+./inc/classes/exceptions/database/general/class_DatabaseUpdateSupportException.php:10: * @deprecated
+./inc/classes/exceptions/io/class_FileNotFoundException.php:11: * @deprecated
+./inc/classes/exceptions/io/class_InvalidDirectoryResourceException.php:10: * @deprecated
+./inc/classes/exceptions/main/class_ClassNotFoundException.php:11: * @deprecated
+./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:11: * @deprecated
+./inc/classes/exceptions/main/class_ExceptionNotFoundException.php:11: * @deprecated
+./inc/classes/exceptions/main/class_GetterNotFoundException.php:11: * @deprecated
+./inc/classes/exceptions/main/class_MissingMethodException.php:10: * @deprecated
+./inc/classes/exceptions/main/class_NoArrayCreatedException.php:11: * @deprecated
+./inc/classes/main/filter/class_AbstractFilterDecorator.php:2:// @DEPRECATED
+./inc/classes/main/template/class_BaseTemplateEngine.php:1131:  * @deprecated
+./inc/config/class_FrameworkConfiguration.php:107:      * @deprecated
diff --git a/todo-builder.sh b/todo-builder.sh
new file mode 100755 (executable)
index 0000000..c1941f5
--- /dev/null
@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# This script helps building the file docs/TODOs.txt and should be executed by
+# developers with SVN write-access
+
+if ! test -e "index.php"; then
+  echo "$0: Please execute this script from root directory."
+  exit 1
+fi
+
+echo "$0: Generating TODOs.txt..."
+echo "### WARNING: THIS FILE IS AUTO-GENERATED BY $0 ###" > docs/TODOs.txt
+echo "### DO NOT EDIT THIS FILE. ###" >> docs/TODOs.txt
+find -type f -name "*.php" -exec grep -Hin "@TODO" {} \; | sort >> docs/TODOs.txt
+echo "### ### DEPRECATION FOLLOWS: ### ###" >> docs/TODOs.txt
+find -type f -name "*.php" -exec grep -Hin "@DEPRECATED" {} \; | sort >> docs/TODOs.txt
+echo "$0: Done."
+exit 0