NeoMutt  2021-10-22-8-g9cb437
Teaching an old dog new tricks
DOXYGEN
mutt_socket.c File Reference

NeoMutt connections. More...

#include "config.h"
#include <stdio.h>
#include <string.h>
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "conn/lib.h"
#include "mutt_socket.h"
#include "hook.h"
#include "mutt_account.h"
+ Include dependency graph for mutt_socket.c:

Go to the source code of this file.

Functions

struct Connectionmutt_conn_new (const struct ConnAccount *cac)
 Create a new Connection. More...
 
struct Connectionmutt_conn_find (const struct ConnAccount *cac)
 Find a connection from a list. More...
 

Detailed Description

NeoMutt connections.

Authors
  • Brendan Cully

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file mutt_socket.c.

Function Documentation

◆ mutt_conn_new()

struct Connection* mutt_conn_new ( const struct ConnAccount cac)

Create a new Connection.

Parameters
cacCredentials to use
Return values
ptrNew Connection

Definition at line 48 of file mutt_socket.c.

49 {
50  enum ConnectionType conn_type;
51 
52  const char *const c_tunnel = cs_subset_string(NeoMutt->sub, "tunnel");
53  if (c_tunnel)
54  conn_type = MUTT_CONNECTION_TUNNEL;
55  else if (cac->flags & MUTT_ACCT_SSL)
56  conn_type = MUTT_CONNECTION_SSL;
57  else
58  conn_type = MUTT_CONNECTION_SIMPLE;
59 
60  struct Connection *conn = mutt_socket_new(conn_type);
61  if (conn)
62  {
63  memcpy(&conn->account, cac, sizeof(struct ConnAccount));
64  }
65  else
66  {
67  if (conn_type == MUTT_CONNECTION_SSL)
68  {
69 #ifndef USE_SSL
70  /* that's probably why it failed */
71  mutt_error(_("SSL is unavailable, can't connect to %s"), cac->host);
72 #endif
73  }
74  }
75  return conn;
76 }
#define MUTT_ACCT_SSL
Account uses SSL/TLS.
Definition: connaccount.h:47
#define mutt_error(...)
Definition: logging.h:87
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:317
#define _(a)
Definition: message.h:28
struct Connection * mutt_socket_new(enum ConnectionType type)
Allocate and initialise a new connection.
Definition: socket.c:280
ConnectionType
Type of connection.
Definition: socket.h:35
@ MUTT_CONNECTION_SSL
SSL/TLS-encrypted connection.
Definition: socket.h:38
@ MUTT_CONNECTION_SIMPLE
Simple TCP socket connection.
Definition: socket.h:36
@ MUTT_CONNECTION_TUNNEL
Tunnelled connection.
Definition: socket.h:37
Login details for a remote server.
Definition: connaccount.h:53
char host[128]
Server to login to.
Definition: connaccount.h:54
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:60
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:50
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_conn_find()

struct Connection* mutt_conn_find ( const struct ConnAccount cac)

Find a connection from a list.

Parameters
cacConnAccount to match
Return values
ptrMatching Connection

find a connection off the list of connections whose account matches cac. If start is not null, only search for connections after the given connection (allows higher level socket code to make more fine-grained searches than account info. Eg in IMAP we may wish to find a connection which is not in IMAP_SELECTED state)

Definition at line 89 of file mutt_socket.c.

90 {
91  struct Url url = { 0 };
92  char hook[1024];
93 
94  /* cac isn't actually modified, since url isn't either */
95  mutt_account_tourl((struct ConnAccount *) cac, &url);
96  url.path = NULL;
97  url_tostring(&url, hook, sizeof(hook), U_NO_FLAGS);
98  mutt_account_hook(hook);
99 
100  return mutt_conn_new(cac);
101 }
void mutt_account_hook(const char *url)
Perform an account hook.
Definition: hook.c:781
void mutt_account_tourl(struct ConnAccount *cac, struct Url *url)
Fill URL with info from account.
Definition: mutt_account.c:79
struct Connection * mutt_conn_new(const struct ConnAccount *cac)
Create a new Connection.
Definition: mutt_socket.c:48
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition: url.h:69
char * path
Path.
Definition: url.h:75
int url_tostring(struct Url *url, char *dest, size_t len, uint8_t flags)
Output the URL string for a given Url object.
Definition: url.c:418
#define U_NO_FLAGS
Definition: url.h:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function: