Add some notes on getting in contact with the dev community
[asterisk/asterisk.git] / doc / google-soc2009-ideas.txt
1 ================================================================================
2 ===                     Google Summer of Code 2009                           ===
3 ===                                                                          ===
4 ===                      http://www.asterisk.org/                            ===
5 ===                                                                          ===
6 ===                      <asteriskteam@digium.com>                           ===
7 ================================================================================
8
9 --------------------------------------------------------------------------------
10 --- Personnel ------------------------------------------------------------------
11 --------------------------------------------------------------------------------
12
13 Administrator: Russell Bryant
14
15 Mentors:       Russell Bryant
16                Joshua Colp
17                Mark Michelson
18                Tilghman Lesher
19                Luigi Rizzo
20
21 Contact:
22
23     To get in contact with mentors or the Asterisk development community in
24         general, the best place is the asterisk-dev mailing list, hosted on 
25         http://lists.digium.com/.  Alternatively, many developers can be found in
26         the #asterisk-dev IRC channel on Freenode.  The most active time for this
27         channel on IRC is during US business hours.
28
29         Feel free to get in contact with the development community ahead of time if
30         you are a student interested in applying for a project with Asterisk.  We
31         can help explain projects proposed here, or help come up with potential
32         alternative project proposals.
33
34 --------------------------------------------------------------------------------
35 --------------------------------------------------------------------------------
36
37 --------------------------------------------------------------------------------
38 --- Project Ideas --------------------------------------------------------------
39 --------------------------------------------------------------------------------
40
41 1) There are a number of projects that fall into the category of improving and
42    creating new interfaces for developers to interface with Asterisk.  To get a
43    bit of an idea for the higher level vision of this effort, see the following
44    wiki page: <http://astridevcon.pbwiki.com/Codename-Pinemango/>.  
45   
46    Some insight regarding the motivation for this overall effort is captured
47    in this mailing list post, written by Brian Degenhardt.
48
49     - http://lists.digium.com/pipermail/asterisk-dev/2008-October/034700.html
50
51    Specific project ideas in this area are listed here:
52
53    a) Create a generic "data get" layer for Asterisk components to be able to
54       expose data that they maintain.  Currently, modules implement specific
55       code to implement CLI commands, manager interface actions, and so forth,
56       while it would be much nicer to have this data available through a common
57       interface.  For example, SNMP support has been added to Asterisk but is
58       limited in what it can expose due to the lack of this interface.  This
59       project would be to create the infrastructure for this data layer and some
60       uses to prove its functionality.  Then, various parts of Asterisk could
61       be converted as time permits.  Note that this may end up sharing some code
62       with the "data put" interface in part b.
63
64    b) Create a generic "data put" layer for Asterisk components to allow
65       external interfaces to update configuration items, as opposed to having
66       to issue a full configuration reload to account for a single change.
67       This project would involve writing the infrastructure and some basic usage
68       to prove its functionality.  Various parts of Asterisk could be converted
69       as time permits.  Note that this may end up sharing some code with the
70       "data get" interface in part a.
71
72    c) Improve the performance of cache handling in the event core.  The event
73       API in Asterisk provides a generic interface for subscribing to and
74       publishing asynchronous events.  It also provides a caching mechanism for
75       events that represent state changes.  So, to find out a state, you can
76       pull it out of the event cache.  For example, the state of devices as used
77       for presence is handled using this mechanism.  The data structures
78       currently used for maintaining the cache are not optimal for performance
79       when the cache gets large.  This project would be to write code to
80       benchmark the performance of the caching mechanism, and then implement a
81       new storage mechanism that is more efficient.
82
83    d) Develop a method for federating Asterisk servers using distributed events
84       with a transport suitable for communication beyond a LAN.  The current
85       event infrastructure includes ways to hook in and distribute events
86       between servers.  There is a module which implements this, res_ais, but
87       it is only suitable for federating servers on a high speed LAN.  This
88       project would be to implement a new event distribution module using a
89       protocol such as XMPP, or something else if deemed appropriate.
90
91    e) Implement a method that makes it very easy to add synchronous hooks 
92       throughout the code base.  Hooks are arbitrary callbacks within the 
93       internals of asterisk where external components can modify asterisk's 
94       behavior.  While the dialplan allows applications to control much of the 
95       asterisk behavior, hooks allow for business logic to be applied to 
96       situations that are not associated with a call (eg: a sip registration 
97       hook could allow time-governed registration period), or for situations 
98       that occur during the execution of a dialplan application (eg: codec 
99       negotiation hook to apply business logic to codecs proposed in the middle 
100       of a Dial command, or a transfer hook to execute business logic when a 
101       SIP REINVITE is received).
102
103    f) Asterisk has a relatively new generic asynchronous event API. While it 
104       has been implemented in several areas of the code base, one place where 
105       it has not been utilized but would make a great fit would be to replace 
106       the legacy code used for generating events on the Asterisk Manager 
107       Interface (AMI).  The first phase of this project would be to go through
108       the code base and generate new generic Asterisk events in places where
109       manager events are generated today.  That means that those events would
110       be available to any part of Asterisk that would be interested in doing
111       something with them in a binary format as opposed to a big string.
112       
113       As time permits, a second phase to this project would be to either write
114       a new socket based interface that exposes the generic event API, or to
115       modify the existing manager interface to use the ast_event API to handle
116       receiving events from inside of Asterisk to send to manager clients.
117        
118 2) This section contains projects related to Voicemail support in Asterisk.
119
120    a) Extract the support for storage backends into an API to reduce code
121       complexity and its ability to be reused.  The current Asterisk voicemail
122       application supports storing voicemail on the filesystem, in a database
123       via ODBC, and on an IMAP server.  All of the storage code should be pulled
124       out into a form such that it makes the current app_voicemail easier to
125       maintain, but also allows the backend storage code to be used in a next
126       generation voicemail implementation, or potentially other things in
127       Asterisk that would like to use these interfaces.
128
129    b) One feature that has been widely desired for Asterisk voicemail is the
130       ability to customize menu layout.  This project would be to improve
131       existing code, or develop a new voicemail application that supports
132       customizable menu layout.  The app_minivm module currently in Asterisk
133       is one way of approaching this project, which is to break up current
134       Voicemail functionality into smaller applications to make it easier to
135       build a custom voicemail system in the dialplan.  Luigi Rizzo had a
136       student work on a project to create a new voicemail system that included
137       these features that has some work left to be completed.
138
139 3) This section includes projects related to improving the Asterisk console and
140    logging interfaces.
141
142    a) Improve the way "verbose logging" works in Asterisk.  Currently, the
143       Asterisk console and logging system only supports a single verbose level.
144       However, it would be extremely useful to allow a verbose setting per
145       console, and per log file that verbose output is being sent to.
146
147    b) Improve Asterisk logging such that advanced filtering is available at the
148       console so that output related to a single call is available without
149       having to see the output for other calls.  Lack of support for debugging
150       individual calls has been a long standing difficulty for Asterisk
151       administrators on busy systems.
152
153    c) In addition to being used as an administrative interface, the Asterisk
154       console can also be used for making calls using the system audio and
155       video interfaces.  In this sense, Asterisk can be used as a highly
156       configurable console based soft phone.  Luigi Rizzo and some of his
157       students have put a lot of work into adding video support to the Asterisk
158       console when being used as a softphone.  This project would be to work
159       with Luigi to continue this effort to improve the GUI that opens up for
160       handling calls.  This would involve adding some buttons to handle calls
161       and contact lists, controlling the active audio source for a call, and
162       adding standard telephone buttons.
163
164 4) This section includes projects related to internationalization.
165
166    a) One of the projects that Luigi Rizzo previously worked on was replacing
167       the "say.c" code that implemented language support for saying dates and
168       times in C code, with an implementation that allows additional languages
169       to be added via a configuration file with special syntax.  This project
170       would be to work with Luigi to enhance this code to better handle
171       languages where words change in multiple ways depending on gender and
172       number, and also adding more languages to the sample configuration file
173       that is distributed with Asterisk.
174
175 5) This section includes projects related to portability to other operating
176    systems.
177
178    a) Asterisk has been ported to cygwin a couple of times over the years, but
179       tends to bitrot due to lack of continued support by developers.  This
180       project would be to revisit the current state of cygwin support and get
181       it working well in Asterisk 1.6.  It should already compile, or be very
182       close to it.  However, there is some testing to be done to ensure that
183       things work properly.  Also, it would be most excellent to get a console
184       channel driver functioning in cygwin (chan_oss, chan_console, etc.).
185
186 6) There are a number of potential projects that could be done to improve
187    security in Asterisk.  A document that lists some of the security challenges
188    currently faced and some ideas for improvements that could be made can be
189    found in the following document:
190
191    http://astridevcon.pbwiki.com/Network-Security-Framework
192
193 --------------------------------------------------------------------------------
194 --------------------------------------------------------------------------------
195
196 ================================================================================
197 ================================================================================